diff --git a/CHANGELOG.md b/CHANGELOG.md
index 0038da1a..c965a140 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,97 +1,122 @@
# Changelog
-## [Unreleased]
+## [Unreleased][unreleased]
## [3.0.3] - 2018-12-09
### Changed
-* Upgrade `slump` devDependency from `~2.0.0` to `~3.0.0` (#76) (@vweevers)
+
+- Upgrade `slump` devDependency from `~2.0.0` to `~3.0.0` ([#76](https://github.com/level/rocksdb/issues/76)) ([**@vweevers**](https://github.com/vweevers))
### Fixed
-* Add `sys/sysmacros.h` for build on modern glibc (#86) (@lachesis)
+
+- Add `sys/sysmacros.h` for build on modern glibc ([#86](https://github.com/level/rocksdb/issues/86)) ([**@lachesis**](https://github.com/lachesis))
### Removed
-* Remove unused `port-libuv` directory (#81) (@filoozom)
+
+- Remove unused `port-libuv` directory ([#81](https://github.com/level/rocksdb/issues/81)) ([**@filoozom**](https://github.com/filoozom))
## [3.0.2] - 2018-10-25
### Changed
-* Upgrade `Snappy` to `1.1.7` (@filoozom)
+
+- Upgrade `Snappy` to `1.1.7` ([**@filoozom**](https://github.com/filoozom))
## [3.0.1] - 2018-05-22
### Added
-* Add upgrade guide (@ralphtheninja)
+
+- Add upgrade guide ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Changed
-* Upgrade to `abstract-leveldown@~5.0.0` (@ralphtheninja)
+
+- Upgrade to `abstract-leveldown@~5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
## [3.0.0] - 2018-05-21
### Added
-* Add node 10 to Travis and AppVeyor (@ralphtheninja)
-* Add default export (@meirionhughes)
-* Add `standard` (@ralphtheninja)
+
+- Add node 10 to Travis and AppVeyor ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Add default export ([**@meirionhughes**](https://github.com/meirionhughes))
+- Add `standard` ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Changed
-* Upgrade to `nan@2.10.0` (@ralphtheninja)
-* Upgrade to `prebuild-install@4.0.0` (@ralphtheninja)
-* Upgrade to `verify-travis-appveyor@3.0.0` (@ralphtheninja)
-* Replace deprecated `node-uuid` with `uuid` (@ralphtheninja)
+
+- Upgrade to `nan@2.10.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade to `prebuild-install@4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade to `verify-travis-appveyor@3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Replace deprecated `node-uuid` with `uuid` ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Fixed
-* Fix nan deprecation warnings (@ralphtheninja)
+
+- Fix nan deprecation warnings ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Removed
-* Remove node 4 from Travis and AppVeyor (@ralphtheninja)
-* Remove TypeScript typings (@meirionhughes, @ralphtheninja)
+
+- Remove node 4 from Travis and AppVeyor ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Remove TypeScript typings ([**@meirionhughes**](https://github.com/meirionhughes), [**@ralphtheninja**](https://github.com/ralphtheninja))
## [2.0.0] - 2018-02-12
### Added
-* Add `verify-travis-appveyor` to tests (@ralphtheninja)
-* Add node 9 to Travis and AppVeyor (@ralphtheninja)
+
+- Add `verify-travis-appveyor` to tests ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Add node 9 to Travis and AppVeyor ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Changed
-* Upgrade to `abstract-leveldown@3.0.0` (@ralphtheninja)
-* Tweak badges in README (@vweevers)
-* Simplify AppVeyor configuration (@vweevers)
-* Upgrade to `nan@2.8.0` (@ralphtheninja)
-* Upgrade to `prebuild@7.0.0` (@ralphtheninja)
-* Upgrade to `abstract-leveldown@4.0.0` (@ralphtheninja)
+
+- Upgrade to `abstract-leveldown@3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Tweak badges in README ([**@vweevers**](https://github.com/vweevers))
+- Simplify AppVeyor configuration ([**@vweevers**](https://github.com/vweevers))
+- Upgrade to `nan@2.8.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade to `prebuild@7.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade to `abstract-leveldown@4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Fixed
-* Fix destroy on Windows (@vweevers)
+
+- Fix destroy on Windows ([**@vweevers**](https://github.com/vweevers))
### Removed
-* Remove node 7 from Travis and AppVeyor (@ralphtheninja)
+
+- Remove node 7 from Travis and AppVeyor ([**@ralphtheninja**](https://github.com/ralphtheninja))
## [1.1.0] - 2017-09-16
### Added
-* Add TypeScript typings (@meirionhughes)
+
+- Add TypeScript typings ([**@meirionhughes**](https://github.com/meirionhughes))
### Changed
-* Upgrade to `nan@2.7.0` (@ralphtheninja)
-* Upgrade to `abstract-leveldown@2.7.0` (@ralphtheninja)
+
+- Upgrade to `nan@2.7.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade to `abstract-leveldown@2.7.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
## [1.0.1] - 2017-08-27
### Added
-* Add Greenkeeper badge (@ralphtheninja)
+
+- Add Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja))
### Changed
-* Update dependencies (@ralphtheninja)
+
+- Update dependencies ([**@ralphtheninja**](https://github.com/ralphtheninja))
## 1.0.0 - 2017-07-01
**Historical Note** Earlier versions were published before `v1.0.0` but the code was then a branch inside [`leveldown`](https://github.com/level/leveldown). This version marks the point where that code was extracted into its own repository thanks to the work of [`@mcollina`](https://github.com/mcollina).
-[Unreleased]: https://github.com/level/rocksdb/compare/v3.0.3...HEAD
+[unreleased]: https://github.com/level/rocksdb/compare/v3.0.3...HEAD
+
[3.0.3]: https://github.com/level/rocksdb/compare/v3.0.2...v3.0.3
+
[3.0.2]: https://github.com/level/rocksdb/compare/v3.0.1...v3.0.2
+
[3.0.1]: https://github.com/level/rocksdb/compare/v3.0.0...v3.0.1
+
[3.0.0]: https://github.com/level/rocksdb/compare/v2.0.0...v3.0.0
+
[2.0.0]: https://github.com/level/rocksdb/compare/v1.1.0...v2.0.0
+
[1.1.0]: https://github.com/level/rocksdb/compare/v1.0.1...v1.1.0
+
[1.0.1]: https://github.com/level/rocksdb/compare/v1.0.0...v1.0.1
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
new file mode 100644
index 00000000..54ce1664
--- /dev/null
+++ b/CONTRIBUTORS.md
@@ -0,0 +1,42 @@
+# Contributors
+
+| Name | GitHub | Social |
+| :---------------------- | :----------------------------------------------------- | :----------------------------------------------------------------------- |
+| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) |
+| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) |
+| **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) |
+| **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** | | |
+| **Christopher Jeffrey** | | |
+| **Gordon Hall** | [**@bookchin**](https://github.com/bookchin) | |
+| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) |
+| **cjihrig** | | |
+| **Geoff Greer** | [**@ggreer**](https://github.com/ggreer) | |
+| **Philippe Schommers** | | |
+| **Meirion Hughes** | [**@MeirionHughes**](https://github.com/MeirionHughes) | |
+| **Nicola Del Gobbo** | [**@NickNaso**](https://github.com/NickNaso) | |
+| **Oguz Bastemur** | [**@obastemur**](https://github.com/obastemur) | [**@obastemur@twitter**](https://twitter.com/obastemur) |
+| **Braydon Fuller** | [**@braydonf**](https://github.com/braydonf) | |
+| **duralog** | | |
+| **Amine Mouafik** | [**@kytwb**](https://github.com/kytwb) | |
+| **James Butler** | [**@sandfox**](https://github.com/sandfox) | |
+| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | |
+| **Eric Swanson** | | |
+| **Anton Whalley** | [**@no9**](https://github.com/no9) | [**@dhigit9@twitter**](https://twitter.com/dhigit9) |
+| **Tim Kuijsten** | [**@timkuijsten**](https://github.com/timkuijsten) | [**@timkuijsten@mastodon.social**](https://mastodon.social/@timkuijsten) |
+| **Michael Nisi** | [**@michaelnisi**](https://github.com/michaelnisi) | |
+| **Sharvil Nanavati** | [**@sharvil**](https://github.com/sharvil) | |
+| **Thorsten Lorenz** | [**@thlorenz**](https://github.com/thlorenz) | |
+| **Aaron Bieber** | [**@qbit**](https://github.com/qbit) | |
+| **Adam Bliss** | [**@abliss**](https://github.com/abliss) | |
+| **flames of love** | | |
+| **mscdex** | [**@mscdex**](https://github.com/mscdex) | |
+| **Dean Landolt** | [**@deanlandolt**](https://github.com/deanlandolt) | |
+| **No9** | | |
+| **Mark Wolfe** | [**@wolfeidau**](https://github.com/wolfeidau) | |
+| **Super-User** | | |
diff --git a/LICENSE.md b/LICENSE.md
index 296b7b7f..d9f5e379 100644
--- a/LICENSE.md
+++ b/LICENSE.md
@@ -1,11 +1,21 @@
-The MIT License (MIT)
-=====================
+# The MIT License (MIT)
-Copyright (c) 2017 Rod Vagg
----------------------------
+**Copyright © 2012-present Rod Vagg and [Contributors](CONTRIBUTORS.md).**
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
index 47c50ccf..a86e842c 100644
--- a/README.md
+++ b/README.md
@@ -42,18 +42,13 @@ There are multiple ways you can find help in using LevelDB in Node.js:
* **Mailing list:** there is an active [Node.js LevelDB](https://groups.google.com/forum/#!forum/node-levelup) Google Group.
* **GitHub:** you're welcome to open an issue here on this GitHub repository if you have a question.
-
## Contributing
-`rocksdb` is an **OPEN Open Source Project**. This means that:
+[`Level/rocksdb`](https://github.com/Level/rocksdb) is an **OPEN Open Source Project**. This means that:
> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
-See the [contribution guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
-
-### Windows
-
-A large portion of the Windows support comes from code by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) [@kjk](https://twitter.com/kjk), see his Windows LevelDB port [here](http://code.google.com/r/kkowalczyk-leveldb/). If you're using LevelUP on Windows, you should give him your thanks!
+See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
## Prebuilt Binaries
@@ -63,13 +58,10 @@ 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.
-
## License
-Copyright © 2012-present `rocksdb` [contributors](https://github.com/level/community#contributors).
-
-`rocksdb` is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included `LICENSE.md` file for more details.
+[MIT](LICENSE.md) © 2012-present Rod Vagg and [Contributors](CONTRIBUTORS.md).
-`rocksdb` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors to the LevelDB fork by Facebook. LevelDB and Snappy are both issued under the [New BSD Licence](http://opensource.org/licenses/BSD-3-Clause).
+_`rocksdb` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors to the LevelDB fork by Facebook. LevelDB and Snappy are both issued under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause). A large portion of `rocksdb` Windows support comes from the [Windows LevelDB port](http://code.google.com/r/kkowalczyk-leveldb/) (archived) by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) ([`@kjk`](https://twitter.com/kjk)). If you're using `rocksdb` on Windows, you should give him your thanks!_
[level-badge]: http://leveldb.org/img/badge.svg
diff --git a/package.json b/package.json
index a80352e2..af32a7ff 100644
--- a/package.json
+++ b/package.json
@@ -1,17 +1,17 @@
{
"name": "rocksdb",
- "description": "A Node.js RocksDB binding, a backend for LevelUP",
"version": "3.0.3",
- "repository": {
- "type": "git",
- "url": "https://github.com/level/rocksdb.git"
- },
- "homepage": "https://github.com/level/rocksdb",
- "keywords": [
- "leveldb",
- "level"
- ],
+ "description": "A Node.js RocksDB binding, a backend for LevelUP",
+ "license": "MIT",
"main": "leveldown.js",
+ "scripts": {
+ "install": "prebuild-install || node-gyp rebuild",
+ "test": "standard && hallmark && verify-travis-appveyor && nyc tape test/*-test.js && prebuild-ci",
+ "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"
+ },
"dependencies": {
"abstract-leveldown": "~5.0.0",
"bindings": "~1.3.0",
@@ -24,7 +24,9 @@
"coveralls": "^3.0.2",
"delayed": "~1.0.1",
"du": "~0.1.0",
+ "hallmark": "^0.1.0",
"iota-array": "~1.0.0",
+ "level-community": "^3.0.0",
"lexicographic-integer": "~1.1.0",
"mkfiletree": "~1.0.1",
"monotonic-timestamp": "~0.0.8",
@@ -40,21 +42,28 @@
"uuid": "^3.2.1",
"verify-travis-appveyor": "^3.0.0"
},
- "scripts": {
- "install": "prebuild-install || node-gyp rebuild",
- "test": "standard && verify-travis-appveyor && nyc tape test/*-test.js && prebuild-ci",
- "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"
- },
- "license": "MIT",
- "gypfile": true,
- "engines": {
- "node": ">=6"
- },
"standard": {
"ignore": [
"deps/*"
]
+ },
+ "hallmark": {
+ "community": "level-community",
+ "ignore": [
+ "README.md"
+ ]
+ },
+ "gypfile": true,
+ "repository": {
+ "type": "git",
+ "url": "https://github.com/level/rocksdb.git"
+ },
+ "homepage": "https://github.com/level/rocksdb",
+ "keywords": [
+ "leveldb",
+ "level"
+ ],
+ "engines": {
+ "node": ">=6"
}
}