From 7ec3f231b0022ce0a551212cc333f5cab572efb7 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Mon, 7 Jan 2019 10:29:51 +0200 Subject: [PATCH] Apply common project tweaks (round 2) (#55) * Add dependency-check * Add Donate section and badges to README.md * Run hallmark * Tweak badges and links in README.md --- CONTRIBUTORS.md | 2 +- README.md | 35 ++++++++++++++++++++++++----------- package.json | 5 ++++- 3 files changed, 29 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index bf65d22..0676cf5 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -3,6 +3,6 @@ | Name | GitHub | Social | | :------------------- | :----------------------------------------------------- | :-------------------------------------------------------------- | | **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) | -| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | | **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) | +| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | | **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) | diff --git a/README.md b/README.md index 50990b1..0ab2713 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,19 @@ > Fast & simple storage. A Node.js-style RocksDB wrapper. -[![level badge][level-badge]](https://github.com/level/awesome) -[![npm](https://img.shields.io/npm/v/level-rocksdb.svg)](https://www.npmjs.com/package/level-rocksdb) -![Node version](https://img.shields.io/node/v/level-rocksdb.svg) -[![Build Status](https://secure.travis-ci.org/Level/level-rocksdb.svg)](http://travis-ci.org/Level/level-rocksdb) -[![dependencies](https://david-dm.org/Level/level-rocksdb.svg)](https://david-dm.org/level/level-rocksdb) -[![npm](https://img.shields.io/npm/dm/level-rocksdb.svg)](https://www.npmjs.com/package/level-rocksdb) +[![level badge][level-badge]](https://github.com/Level/awesome) +[![npm](https://img.shields.io/npm/v/level-rocksdb.svg?label=&logo=npm)](https://www.npmjs.com/package/level-rocksdb) +[![Node version](https://img.shields.io/node/v/level-rocksdb.svg)](https://www.npmjs.com/package/level-rocksdb) +[![Travis](https://img.shields.io/travis/Level/level-rocksdb.svg?logo=travis&label=)](https://travis-ci.org/Level/level-rocksdb) +[![npm](https://img.shields.io/npm/dm/level-rocksdb.svg?label=dl)](https://www.npmjs.com/package/level-rocksdb) [![Coverage Status](https://coveralls.io/repos/github/Level/level-rocksdb/badge.svg)](https://coveralls.io/github/Level/level-rocksdb) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) +[![Backers on Open Collective](https://opencollective.com/level/backers/badge.svg?color=orange)](#backers) +[![Sponsors on Open Collective](https://opencollective.com/level/sponsors/badge.svg?color=orange)](#sponsors) A convenience package that: -* exports a function that returns a [`levelup instance`](https://github.com/level/levelup#ctor) when invoked +* exports a function that returns a [`levelup instance`](https://github.com/Level/levelup#ctor) when invoked * bundles the current release of [`levelup`][levelup] and [`rocksdb`][rocksdb] * leverages encodings using [`encoding-down`][encoding-down] @@ -410,12 +411,24 @@ db.on('put', function (key, value) { See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details. +## Donate + +To sustain [`Level`](https://github.com/Level) and its activities, become a backer or sponsor on [Open Collective](https://opencollective.com/level). Your logo or avatar will be displayed on our 28+ [GitHub repositories](https://github.com/Level), [npm](https://www.npmjs.com/) packages and (soon) [our website](http://leveldb.org). 💖 + +### Backers + +[![Open Collective backers](https://opencollective.com/level/backers.svg?width=890)](https://opencollective.com/level) + +### Sponsors + +[![Open Collective sponsors](https://opencollective.com/level/sponsors.svg?width=890)](https://opencollective.com/level) + ## License [MIT](LICENSE.md) © 2013-present [Contributors](CONTRIBUTORS.md). [level-badge]: http://leveldb.org/img/badge.svg -[levelup]: https://github.com/level/levelup -[level]: https://github.com/level/level -[rocksdb]: https://github.com/level/rocksdb -[encoding-down]: https://github.com/level/encoding-down +[levelup]: https://github.com/Level/levelup +[level]: https://github.com/Level/level +[rocksdb]: https://github.com/Level/rocksdb +[encoding-down]: https://github.com/Level/encoding-down diff --git a/package.json b/package.json index 12d96ba..815379b 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,9 @@ "scripts": { "test": "standard && hallmark && nyc node test.js", "coverage": "nyc report --reporter=text-lcov | coveralls", - "hallmark": "hallmark --fix" + "hallmark": "hallmark --fix", + "dependency-check": "dependency-check . test.js", + "prepublishOnly": "npm run dependency-check" }, "dependencies": { "level-packager": "^4.0.0", @@ -15,6 +17,7 @@ }, "devDependencies": { "coveralls": "^3.0.2", + "dependency-check": "^3.3.0", "hallmark": "^0.1.0", "level-community": "^3.0.0", "nyc": "^12.0.2",