Skip to content
This repository has been archived by the owner on Dec 1, 2024. It is now read-only.

Commit

Permalink
Apply common project tweaks (round 2) (#91)
Browse files Browse the repository at this point in the history
* Add dependency-check

* Add Donate section and badges to README.md

* Unlock 5 devDependencies

* Add .travis.yml, appveyor.yml, .dntrc to .npmignore

* Run hallmark

* Tweak badges and links in README.md
  • Loading branch information
vweevers authored Jan 7, 2019
1 parent 82e3b4e commit 165d8d5
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 16 deletions.
4 changes: 4 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -18,3 +18,7 @@ AUTHORS
Dockerfile
.dockerignore
.nyc_output/

.travis.yml
appveyor.yml
.dntrc
2 changes: 1 addition & 1 deletion CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
| **David Björklund** | [**@kesla**](https://github.com/kesla) | [**@david_bjorklund@twitter**](https://twitter.com/david_bjorklund) |
| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) |
| **Yichao 'Peak' Ji** | [**@peakji**](https://github.com/peakji) | |
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |
| **Mathias Buus** | [**@mafintosh**](https://github.com/mafintosh) | [**@mafintosh@twitter**](https://twitter.com/mafintosh) |
| **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) |
| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | [**@dominictarr@twitter**](https://twitter.com/dominictarr) |
| **Raynos** | | |
Expand Down
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

> A Low-level Node.js RocksDB binding
[![level badge][level-badge]](https://github.com/level/awesome)
[![npm](https://img.shields.io/npm/v/rocksdb.svg)](https://www.npmjs.com/package/rocksdb)
![Node version](https://img.shields.io/node/v/rocksdb.svg)
[![Travis](https://img.shields.io/travis/Level/rocksdb.svg?label=travis)](http://travis-ci.org/Level/rocksdb)
[![AppVeyor](https://img.shields.io/appveyor/ci/Level/rocksdb.svg?label=appveyor)](https://ci.appveyor.com/project/Level/rocksdb)
[![dependencies](https://img.shields.io/david/Level/rocksdb.svg)](https://david-dm.org/level/rocksdb)
[![npm downloads](https://img.shields.io/npm/dm/rocksdb.svg)](https://www.npmjs.com/package/rocksdb)
[![level badge][level-badge]](https://github.com/Level/awesome)
[![npm](https://img.shields.io/npm/v/rocksdb.svg?label=&logo=npm)](https://www.npmjs.com/package/rocksdb)
[![Node version](https://img.shields.io/node/v/rocksdb.svg)](https://www.npmjs.com/package/rocksdb)
[![Travis](https://img.shields.io/travis/Level/rocksdb.svg?logo=travis&label=)](https://travis-ci.org/Level/rocksdb)
[![AppVeyor](https://img.shields.io/appveyor/ci/Level/rocksdb.svg?logo=appveyor&label=)](https://ci.appveyor.com/project/Level/rocksdb)
[![npm downloads](https://img.shields.io/npm/dm/rocksdb.svg?label=dl)](https://www.npmjs.com/package/rocksdb)
[![Coverage Status](https://coveralls.io/repos/github/Level/rocksdb/badge.svg)](https://coveralls.io/github/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)

**If you are upgrading:** please see [UPGRADING.md](UPGRADING.md).

`rocksdb` is based on the [LevelDown](https://github.com/level/leveldown) code, which was extracted from [LevelUP](https://github.com/level/levelup) and now serves as a stand-alone binding for LevelDB. The native code in `rocksdb` is based on [Facebooks fork of LevelDB](https://github.com/facebook/rocksdb).
`rocksdb` is based on the [LevelDown](https://github.com/Level/leveldown) code, which was extracted from [LevelUP](https://github.com/Level/levelup) and now serves as a stand-alone binding for LevelDB. The native code in `rocksdb` is based on [Facebooks fork of LevelDB](https://github.com/facebook/rocksdb).

It is **strongly recommended** that you use LevelUP in preference to `rocksdb` unless you have measurable performance reasons to do so. LevelUP is optimised for usability and safety. Although we are working to improve the safety of the `rocksdb` interface it is still easy to crash your Node process if you don't do things in just the right way.

Expand All @@ -31,7 +32,7 @@ It is **strongly recommended** that you use LevelUP in preference to `rocksdb` u
<a name="api"></a>
## API

`rocksdb` implements the same API of [LevelDown](https://github.com/level/leveldown#api).
`rocksdb` implements the same API of [LevelDown](https://github.com/Level/leveldown#api).

<a name="support"></a>
## Getting Support
Expand All @@ -58,6 +59,18 @@ If you are working on `rocksdb` and want to re-compile the C++ code it's enough

If you don't want to use the `prebuild` for the platform you are installing on, specify the `--build-from-source` flag when you install.

## 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) © 2012-present Rod Vagg and [Contributors](CONTRIBUTORS.md).
Expand Down
15 changes: 9 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,9 @@
"coverage": "nyc report --reporter=text-lcov | coveralls",
"rebuild": "prebuild --compile",
"prebuild": "prebuild -t 8.1.2 -t 6.11.0 -t 4.8.3 -t 7.10.0 --strip --verbose",
"hallmark": "hallmark --fix"
"hallmark": "hallmark --fix",
"dependency-check": "dependency-check . test/*.js bench/*.js",
"prepublishOnly": "npm run dependency-check"
},
"dependencies": {
"abstract-leveldown": "~5.0.0",
Expand All @@ -22,21 +24,22 @@
"devDependencies": {
"async": "^2.0.1",
"coveralls": "^3.0.2",
"delayed": "~1.0.1",
"delayed": "^1.0.1",
"dependency-check": "^3.3.0",
"du": "~0.1.0",
"hallmark": "^0.1.0",
"iota-array": "~1.0.0",
"iota-array": "^1.0.0",
"level-community": "^3.0.0",
"lexicographic-integer": "~1.1.0",
"mkfiletree": "~1.0.1",
"lexicographic-integer": "^1.1.0",
"mkfiletree": "^1.0.1",
"monotonic-timestamp": "~0.0.8",
"nyc": "^12.0.2",
"optimist": "~0.6.1",
"prebuild": "^8.0.0",
"prebuild-ci": "^2.0.0",
"readfiletree": "~0.0.1",
"rimraf": "^2.6.1",
"slump": "~3.0.0",
"slump": "^3.0.0",
"standard": "^12.0.0",
"tape": "^4.5.1",
"uuid": "^3.2.1",
Expand Down

0 comments on commit 165d8d5

Please sign in to comment.