Skip to content

Commit

Permalink
Apply common project tweaks (#580)
Browse files Browse the repository at this point in the history 
* Sort package.json

* Upgrade hallmark devDependency from ~0.1.0 to ^0.1.0

* Add level-community devDependency

* Add hallmark configuration

* Add hallmark to npm scripts

* Add CONTRIBUTORS.md

* Update LICENSE.md

* Update License section in README.md

* Update Contributing section in README.md

* Run hallmark

* Fix 'Do not use upper-case characters in definition labels' in CHANGELOG.md

* Fix repository in package.json

* Fix homepage in package.json
  • Loading branch information
@vweevers
vweevers authored Jan 5, 2019
1 parent d2aa638 commit 5f7f146
Show file tree
Hide file tree
Showing 5 changed files with 96 additions and 39 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Changelog

## [Unreleased]
## [Unreleased][unreleased]

### Changed

Expand All @@ -26,7 +26,7 @@
- Tweak copyright years for less maintenance ([`98cbb4f`](https://github.com/level/leveldown/commit/98cbb4f)) ([**@ralphtheninja**](https://github.com/ralphtheninja))
- Document new platform support and prebuilt binaries ([#558](https://github.com/level/leveldown/issues/558), [#563](https://github.com/level/leveldown/issues/563)) ([**@vweevers**](https://github.com/vweevers))
- Replace `remark-cli` with `hallmark` ([#548](https://github.com/level/leveldown/issues/548)) ([**@vweevers**](https://github.com/vweevers))
- Update `.npmignore` (@vweevers)
- Update `.npmignore` ([**@vweevers**](https://github.com/vweevers))

### Added

Expand Down
46 changes: 46 additions & 0 deletions CONTRIBUTORS.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# 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) |
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |
| **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) | |
| **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) |
| **Philippe Schommers** | | |
| **Christopher Jeffrey** | | |
| **Raynos** | | |
| **Gordon Hall** | [**@bookchin**](https://github.com/bookchin) | |
| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) |
| **Geoff Greer** | [**@ggreer**](https://github.com/ggreer) | |
| **Meirion Hughes** | [**@MeirionHughes**](https://github.com/MeirionHughes) | |
| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) |
| **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) | |
| **Super-User** | | |
| **Luandro** | [**@luandro**](https://github.com/luandro) | |
| **Joyee Cheung** | [**@joyeecheung**](https://github.com/joyeecheung) | [**@joyeecheung@twitter**](https://twitter.com/joyeecheung) |
| **Andre Staltz** | | |
| **Nathan Shively-Sanders** | [**@sandersn**](https://github.com/sandersn) | |
| **Huan LI** | [**@zixia**](https://github.com/zixia) | [**@zixia@twitter**](https://twitter.com/zixia) |
| **Michael Ihde** | | |
| **Aaron Bieber** | [**@qbit**](https://github.com/qbit) | |
| **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) | |
| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | |
| **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) | |
| **Alex Gentile** | [**@agentilela**](https://github.com/agentilela) | |
24 changes: 17 additions & 7 deletions LICENSE.md
View file
Original file line number Diff line number Diff line change
@@ -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.
14 changes: 4 additions & 10 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -343,11 +343,11 @@ There are multiple ways you can find help in using LevelDB in Node.js:

## Contributing

`leveldown` is an **OPEN Open Source Project**. This means that:
[`Level/leveldown`](https://github.com/Level/leveldown) 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.
See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.

### Git Submodules

Expand All @@ -374,16 +374,10 @@ $ git submodule update --init --recursive
7. Add changelog to the GitHub release
8. Finally: `npm publish`

### 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 `leveldown` on Windows, you should give him your thanks!

## License

Copyright © 2012-present `leveldown` [contributors](https://github.com/level/community#contributors).

`leveldown` 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).

*`leveldown` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors. LevelDB and Snappy are both issued under the [New BSD Licence](http://opensource.org/licenses/BSD-3-Clause).*
_`leveldown` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors. LevelDB and Snappy are both issued under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause). A large portion of `leveldown` 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 `leveldown` on Windows, you should give him your thanks!_

[level-badge]: http://leveldb.org/img/badge.svg
47 changes: 27 additions & 20 deletions package.json
View file
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
{
"name": "leveldown",
"description": "A low-level Node.js LevelDB binding",
"version": "5.0.0-1",
"repository": {
"type": "git",
"url": "https://github.com/level/leveldown.git"
},
"homepage": "https://github.com/level/leveldown",
"keywords": [
"leveldb",
"level"
],
"description": "A low-level Node.js LevelDB binding",
"license": "MIT",
"main": "leveldown.js",
"scripts": {
"install": "node-gyp-build",
"test": "standard && hallmark && nyc tape test/*-test.js",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"rebuild": "node-gyp rebuild",
"prebuild": "prebuildify -t 8.14.0 -t electron@3.0.0 --napi --strip",
"download-prebuilds": "prebuildify-ci download",
"hallmark": "hallmark --fix"
},
"dependencies": {
"abstract-leveldown": "~6.0.0",
"bindings": "~1.3.0",
Expand All @@ -24,7 +25,8 @@
"coveralls": "^3.0.2",
"delayed": "~1.0.1",
"du": "~0.1.0",
"hallmark": "~0.1.0",
"hallmark": "^0.1.0",
"level-community": "^3.0.0",
"level-concat-iterator": "^2.0.0",
"mkfiletree": "~1.0.1",
"monotonic-timestamp": "~0.0.8",
Expand All @@ -41,17 +43,22 @@
"tempy": "^0.2.1",
"uuid": "^3.2.1"
},
"scripts": {
"install": "node-gyp-build",
"test": "standard && nyc tape test/*-test.js",
"coverage": "nyc report --reporter=text-lcov | coveralls",
"rebuild": "node-gyp rebuild",
"prebuild": "prebuildify -t 8.14.0 -t electron@3.0.0 --napi --strip",
"download-prebuilds": "prebuildify-ci download",
"hallmark": "hallmark --fix UPGRADING.md CHANGELOG.md"
"hallmark": {
"community": "level-community",
"ignore": [
"README.md"
]
},
"license": "MIT",
"gypfile": true,
"repository": {
"type": "git",
"url": "https://github.com/Level/leveldown.git"
},
"homepage": "https://github.com/Level/leveldown",
"keywords": [
"leveldb",
"level"
],
"engines": {
"node": ">=8.6.0"
}
Expand Down

0 comments on commit 5f7f146

Please sign in to comment.