Apply common project tweaks

CHANGELOG.md

@@ -1,67 +1,76 @@
 # Changelog
 
-## [Unreleased]
+## [Unreleased][unreleased]
 
 ## [3.0.0] - 2018-05-22
 
 ### Added
-* Add node 9 and 10 to Travis (@vweevers, @ralphtheninja)
+
+- Add node 9 and 10 to Travis ([**@vweevers**](https://github.com/vweevers), [**@ralphtheninja**](https://github.com/ralphtheninja))
 
 ### Changed
-* Upgrade `abstract-leveldown` to `5.0.0` (@ralphtheninja)
-* Upgrade `standard` to `11.0.0` (@ralphtheninja)
-* Tweak readme (@ralphtheninja)
-* Use `airtap` instead of `zuul` (@vweevers)
-* Switch to plain MIT license (@vweevers)
+
+- Upgrade `abstract-leveldown` to `5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Upgrade `standard` to `11.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Tweak readme ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Use `airtap` instead of `zuul` ([**@vweevers**](https://github.com/vweevers))
+- Switch to plain MIT license ([**@vweevers**](https://github.com/vweevers))
 
 ### Removed
-* Remove TypeScript typings (@ralphtheninja)
-* Remove TypeScript tests (@vweevers)
-* Remove node 4 from Travis (@ralphtheninja)
-* Remove deprecated JWT addon from Travis (@vweevers)
-* Remove obsolete `--stderr` flag (@vweevers)
+
+- Remove TypeScript typings ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Remove TypeScript tests ([**@vweevers**](https://github.com/vweevers))
+- Remove node 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Remove deprecated JWT addon from Travis ([**@vweevers**](https://github.com/vweevers))
+- Remove obsolete `--stderr` flag ([**@vweevers**](https://github.com/vweevers))
 
 ## [2.0.0] - 2018-02-11
 
 ### Added
-* Run test suite with TypeScript in addition to Node.js (@vweevers)
-* Add `UPGRADING.md` (@vweevers)
-* Add `CHANGELOG.md` (@vweevers)
-* README: explain types and snapshot guarantees (@vweevers)
-* README: add level badge (@ralphtheninja)
-* README: add node version badge (@ralphtheninja)
+
+- Run test suite with TypeScript in addition to Node.js ([**@vweevers**](https://github.com/vweevers))
+- Add `UPGRADING.md` ([**@vweevers**](https://github.com/vweevers))
+- Add `CHANGELOG.md` ([**@vweevers**](https://github.com/vweevers))
+- README: explain types and snapshot guarantees ([**@vweevers**](https://github.com/vweevers))
+- README: add level badge ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- README: add node version badge ([**@ralphtheninja**](https://github.com/ralphtheninja))
 
 ### Changed
-* Update `abstract-leveldown` to 4.0.0 (@vweevers)
-* Perform serialization through idiomatic `_serializeKey` and `_serializeValue` (@vweevers)
-* Don't stringify anything except nullish values (@vweevers)
-* Use `Buffer.isBuffer()` instead of `AbstractLevelDOWN#isBuffer` (@vweevers)
-* README: update instantiation instructions for latest `levelup` (@kumavis)
-* README: rename "database" to "store" (@ralphtheninja)
-* README: simplify example and prefer ES6 (@vweevers)
-* Configure Greenkeeper to ignore updates to `@types/node` (@ralphtheninja)
+
+- Update `abstract-leveldown` to 4.0.0 ([**@vweevers**](https://github.com/vweevers))
+- Perform serialization through idiomatic `_serializeKey` and `_serializeValue` ([**@vweevers**](https://github.com/vweevers))
+- Don't stringify anything except nullish values ([**@vweevers**](https://github.com/vweevers))
+- Use `Buffer.isBuffer()` instead of `AbstractLevelDOWN#isBuffer` ([**@vweevers**](https://github.com/vweevers))
+- README: update instantiation instructions for latest `levelup` ([**@kumavis**](https://github.com/kumavis))
+- README: rename "database" to "store" ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- README: simplify example and prefer ES6 ([**@vweevers**](https://github.com/vweevers))
+- Configure Greenkeeper to ignore updates to `@types/node` ([**@ralphtheninja**](https://github.com/ralphtheninja))
 
 ### Fixed
-* Don't clone `Buffer` in iterator (@vweevers)
-* Stringify `Buffer.from()` argument in iterator (@vweevers)
-* README: use SVG rather than PNG badge for Travis (@ralphtheninja)
-* README: link to `abstract-leveldown` (@vweevers)
-* README: normalize markdown headers (@ralphtheninja)
-* README: fix license typos (@ralphtheninja)
-* README: fix code example (@ralphtheninja)
-* Rename `iterator#_end` to fix conflict with `abstract-leveldown` (@vweevers)
-* Set `zuul --concurrency` to 1 to avoid hitting Sauce Labs limit (@vweevers)
-* Test on Android 6.0 instead of latest (7.1) due to Sauce Labs issue (@vweevers)
+
+- Don't clone `Buffer` in iterator ([**@vweevers**](https://github.com/vweevers))
+- Stringify `Buffer.from()` argument in iterator ([**@vweevers**](https://github.com/vweevers))
+- README: use SVG rather than PNG badge for Travis ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- README: link to `abstract-leveldown` ([**@vweevers**](https://github.com/vweevers))
+- README: normalize markdown headers ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- README: fix license typos ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- README: fix code example ([**@ralphtheninja**](https://github.com/ralphtheninja))
+- Rename `iterator#_end` to fix conflict with `abstract-leveldown` ([**@vweevers**](https://github.com/vweevers))
+- Set `zuul --concurrency` to 1 to avoid hitting Sauce Labs limit ([**@vweevers**](https://github.com/vweevers))
+- Test on Android 6.0 instead of latest (7.1) due to Sauce Labs issue ([**@vweevers**](https://github.com/vweevers))
 
 ### Removed
-* Remove global store (@vweevers)
-* Remove skipping of falsy elements in `MemDOWN#batch` (@vweevers)
-* Remove obsolete benchmarks (@vweevers)
-* Remove obsolete `testBuffer` from `test.js` (@vweevers)
-* Remove redundant `testCommon` parameter from most tests (@vweevers)
-* Remove unnecessary `rimraf` replacement for Browserify (@vweevers)
-* README: remove Greenkeeper badge (@ralphtheninja)
-
-[Unreleased]: https://github.com/level/memdown/compare/v3.0.0...HEAD
+
+- Remove global store ([**@vweevers**](https://github.com/vweevers))
+- Remove skipping of falsy elements in `MemDOWN#batch` ([**@vweevers**](https://github.com/vweevers))
+- Remove obsolete benchmarks ([**@vweevers**](https://github.com/vweevers))
+- Remove obsolete `testBuffer` from `test.js` ([**@vweevers**](https://github.com/vweevers))
+- Remove redundant `testCommon` parameter from most tests ([**@vweevers**](https://github.com/vweevers))
+- Remove unnecessary `rimraf` replacement for Browserify ([**@vweevers**](https://github.com/vweevers))
+- README: remove Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja))
+
+[unreleased]: https://github.com/level/memdown/compare/v3.0.0...HEAD
+
 [3.0.0]: https://github.com/level/memdown/compare/v2.0.0...v3.0.0
+
 [2.0.0]: https://github.com/level/memdown/compare/v1.4.1...v2.0.0

CONTRIBUTORS.md

@@ -0,0 +1,20 @@
+# Contributors
+
+| Name                 | GitHub                                                 | Social                                                        |
+| :------------------- | :----------------------------------------------------- | :------------------------------------------------------------ |
+| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@[email protected]**](https://social.weho.st/@ralph)    |
+| **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)               |
+| **Nolan Lawson**     | [**@nolanlawson**](https://github.com/nolanlawson)     | [**@[email protected]**](https://toot.cafe/@nolan)              |
+| **Calvin Metcalf**   | [**@calvinmetcalf**](https://github.com/calvinmetcalf) |                                                               |
+| **Julian Gruber**    | [**@juliangruber**](https://github.com/juliangruber)   | [**@juliangruber@twitter**](https://twitter.com/juliangruber) |
+| **Michael Hart**     | [**@mhart**](https://github.com/mhart)                 | [**@hichaelmart@twitter**](https://twitter.com/hichaelmart)   |
+| **Mathias Buus**     | [**@mafintosh**](https://github.com/mafintosh)         | [**@mafintosh@twitter**](https://twitter.com/mafintosh)       |
+| **Dominic Tarr**     | [**@dominictarr**](https://github.com/dominictarr)     | [**@dominictarr@twitter**](https://twitter.com/dominictarr)   |
+| **Meirion Hughes**   | [**@MeirionHughes**](https://github.com/MeirionHughes) |                                                               |
+| **Max Ogden**        | [**@maxogden**](https://github.com/maxogden)           | [**@maxogden@twitter**](https://twitter.com/maxogden)         |
+| **kumavis**          | [**@kumavis**](https://github.com/kumavis)             |                                                               |
+| **Kirill Fomichev**  | [**@fanatid**](https://github.com/fanatid)             |                                                               |
+| **Marco Oliveira**   | [**@marcooliveira**](https://github.com/marcooliveira) | [**@sonicspot@twitter**](https://twitter.com/sonicspot)       |
+| **Will White**       | [**@willwhite**](https://github.com/willwhite)         |                                                               |
+| **Tim Oxley**        | [**@timoxley**](https://github.com/timoxley)           | [**@secoif@twitter**](https://twitter.com/secoif)             |

LICENSE.md

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# The MIT License (MIT)
 
-Copyright (c) 2013-2018 Rod Vagg (the "Original Author")
+**Copyright © 2013-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

README.md

@@ -36,7 +36,7 @@ Your data is discarded when the process ends or you release a reference to the s
 
 [![Sauce Test Status](https://saucelabs.com/browser-matrix/level-ci.svg)](https://saucelabs.com/u/level-ci)
 
-`memdown` requires a ES5-capable browser. If you're using one that's isn't (e.g. PhantomJS, Android < 4.4, IE < 10) then you will need [es5-shim](https://github.com/es-shims/es5-shim).
+`memdown` requires a ES5-capable browser. If you're using one that's isn't (e.g. PhantomJS, Android &lt; 4.4, IE &lt; 10) then you will need [es5-shim](https://github.com/es-shims/es5-shim).
 
 ## Data types
 
@@ -117,11 +117,23 @@ db.put('key', obj, (err) => {
 
 In addition to the regular `npm test`, you can test `memdown` in a browser of choice with:
 
-    npm run test-browser-local
+```
+npm run test-browser-local
+```
 
 To check code coverage:
 
-    npm run coverage
+```
+npm run coverage
+```
+
+## Contributing
+
+[`Level/memdown`](https://github.com/Level/memdown) 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.
 
 ## Big Thanks
 
@@ -131,11 +143,16 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http
 
 ## License
 
-`memdown` is Copyright (c) 2013-present Rod Vagg [@rvagg](https://twitter.com/rvagg) and licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.
+[MIT](LICENSE.md) © 2013-present Rod Vagg and [Contributors](CONTRIBUTORS.md).
 
 [`abstract-leveldown`]: https://github.com/Level/abstract-leveldown
+
 [`levelup`]: https://github.com/Level/levelup
+
 [`encoding-down`]: https://github.com/Level/encoding-down
+
 [`leveldown`]: https://github.com/Level/leveldown
+
 [`level-mem`]: https://github.com/Level/mem
+
 [level-badge]: http://leveldb.org/img/badge.svg

UPGRADING.md

@@ -50,6 +50,9 @@ const db = window.mydb = levelup(memdown())
 Instead of skipping `null` operations, `db.batch([null])` will throw an error courtesy of [`abstract-leveldown`][abstract-leveldown].
 
 [changelog]: CHANGELOG.md
+
 [abstract-leveldown]: https://github.com/Level/abstract-leveldown
+
 [levelup]: https://github.com/Level/levelup
+
 [encoding-down]: https://github.com/Level/encoding-down

package.json

@@ -1,21 +1,29 @@
 {
   "name": "memdown",
-  "description": "An drop-in replacement for LevelDOWN that works in memory only",
   "version": "3.0.0",
-  "homepage": "https://github.com/Level/memdown",
+  "description": "An drop-in replacement for LevelDOWN that works in memory only",
   "authors": [
     "Rod Vagg <[email protected]> (https://github.com/rvagg)"
   ],
-  "keywords": [
-    "leveldb",
-    "leveldown",
-    "levelup",
-    "memory"
-  ],
+  "license": "MIT",
   "main": "memdown.js",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/Level/memdown.git"
+  "scripts": {
+    "test": "standard && hallmark && nyc node test.js",
+    "test-browsers": "airtap --loopback airtap.local --coverage test.js",
+    "test-browser-local": "airtap --coverage --local test.js",
+    "coverage": "nyc report --reporter=text-lcov | coveralls",
+    "hallmark": "hallmark --fix"
+  },
+  "files": [
+    "memdown.js",
+    "immediate.js",
+    "immediate-browser.js",
+    "UPGRADING.md",
+    "CHANGELOG.md",
+    "CONTRIBUTORS.md"
+  ],
+  "browser": {
+    "./immediate.js": "./immediate-browser.js"
   },
   "dependencies": {
     "abstract-leveldown": "~5.0.0",
@@ -28,28 +36,29 @@
   "devDependencies": {
     "airtap": "^2.0.0",
     "coveralls": "^3.0.2",
+    "hallmark": "^0.1.0",
+    "level-community": "^3.0.0",
     "nyc": "^12.0.2",
     "rimraf": "^2.6.2",
     "standard": "^12.0.0",
     "tape": "^4.8.0"
   },
-  "browser": {
-    "./immediate.js": "./immediate-browser.js"
+  "hallmark": {
+    "community": "level-community"
   },
-  "scripts": {
-    "test": "standard && nyc node test.js",
-    "test-browsers": "airtap --loopback airtap.local --coverage test.js",
-    "test-browser-local": "airtap --coverage --local test.js",
-    "coverage": "nyc report --reporter=text-lcov | coveralls"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Level/memdown.git"
   },
-  "license": "MIT",
+  "homepage": "https://github.com/Level/memdown",
+  "keywords": [
+    "level",
+    "leveldb",
+    "leveldown",
+    "levelup",
+    "memory"
+  ],
   "engines": {
     "node": ">=6"
-  },
-  "files": [
-    "memdown.js",
-    "immediate.js",
-    "immediate-browser.js",
-    "UPGRADING.md"
-  ]
+  }
 }