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

Commit eeac40b

Browse files
authored
Apply common project tweaks (#12)
* Sort package.json * Add 'level' to package keywords * Add hallmark devDependency * Add level-community devDependency * Add hallmark configuration * Add hallmark to npm scripts * 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
1 parent 0c1d4e0 commit eeac40b

File tree

5 files changed

+53
-25
lines changed

5 files changed

+53
-25
lines changed

CHANGELOG.md

+12-8
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
# Changelog
22

3-
## [Unreleased]
3+
## [Unreleased][unreleased]
44

55
## [2.0.0] - 2018-06-27
66

77
### Changed
8-
* Detect end by checking key and value (@vweevers)
9-
* Use `level` in example instead of `leveldown` (@ralphtheninja)
10-
* End iterator if next errors (@ralphtheninja)
8+
9+
- Detect end by checking key and value ([**@vweevers**](https://github.com/vweevers))
10+
- Use `level` in example instead of `leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja))
11+
- End iterator if next errors ([**@ralphtheninja**](https://github.com/ralphtheninja))
1112

1213
### Removed
13-
* Remove custom `nextTick` parameter (@ralphtheninja)
14+
15+
- Remove custom `nextTick` parameter ([**@ralphtheninja**](https://github.com/ralphtheninja))
1416

1517
### Added
16-
* Add `homepage` and `repository` to `package.json` (@ralphtheninja)
17-
* Add `UPGRADING.md` (@ralphtheninja)
18+
19+
- Add `homepage` and `repository` to `package.json` ([**@ralphtheninja**](https://github.com/ralphtheninja))
20+
- Add `UPGRADING.md` ([**@ralphtheninja**](https://github.com/ralphtheninja))
1821

1922
## 1.0.0 - 2018-06-24
2023

2124
:seedling: Initial release.
2225

23-
[Unreleased]: https://github.com/level/level/compare/v2.0.0...HEAD
26+
[unreleased]: https://github.com/level/level/compare/v2.0.0...HEAD
27+
2428
[2.0.0]: https://github.com/level/level/compare/v1.0.0...v2.0.0

CONTRIBUTORS.md

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
11
# Contributors
2+
3+
| Name | GitHub | Social |
4+
| :------------------- | :----------------------------------------------------- | :--------------------------------------------------------- |
5+
| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) |
6+
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |

LICENSE.md

+16-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
# The MIT License (MIT)
22

3-
**Copyright © 2018-present `level-concat-iterator` [Contributors](./CONTRIBUTORS.md).**
3+
**Copyright © 2018-present [Contributors](CONTRIBUTORS.md).**
44

5-
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:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
611

7-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
814

9-
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.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ Takes an `abstract-leveldown` compatible `iterator` as first parameter and calls
3636

3737
## Contributing
3838

39-
`level-concat-iterator` is an **OPEN Open Source Project**. This means that:
39+
[`Level/concat-iterator`](https://github.com/Level/concat-iterator) is an **OPEN Open Source Project**. This means that:
4040

4141
> 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.
4242
43-
See the [`contribution guide`](https://github.com/Level/community/blob/master/CONTRIBUTING.md) file for more details.
43+
See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
4444

4545
## License
4646

47-
[MIT](./LICENSE.md) © 2018-present `level-concat-iterator` [Contributors](./CONTRIBUTORS.md).
47+
[MIT](LICENSE.md) © 2018-present [Contributors](CONTRIBUTORS.md).
4848

4949
[level-badge]: http://leveldb.org/img/badge.svg

package.json

+17-10
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,36 @@
22
"name": "level-concat-iterator",
33
"version": "2.0.0",
44
"description": "Concatenate items from an iterator into an array.",
5+
"author": "Lars-Magnus Skog <[email protected]>",
6+
"license": "MIT",
57
"main": "index.js",
68
"scripts": {
7-
"test": "standard && nyc node test",
8-
"coverage": "nyc report --reporter=text-lcov | coveralls"
9+
"test": "standard && hallmark && nyc node test",
10+
"coverage": "nyc report --reporter=text-lcov | coveralls",
11+
"hallmark": "hallmark --fix"
12+
},
13+
"devDependencies": {
14+
"coveralls": "^3.0.2",
15+
"hallmark": "^0.1.0",
16+
"level-community": "^3.0.0",
17+
"nyc": "^12.0.2",
18+
"standard": "^11.0.1",
19+
"tape": "^4.9.1"
20+
},
21+
"hallmark": {
22+
"community": "level-community"
923
},
1024
"repository": {
1125
"type": "git",
1226
"url": "https://github.com/Level/concat-iterator.git"
1327
},
1428
"homepage": "https://github.com/Level/concat-iterator",
1529
"keywords": [
30+
"level",
1631
"concatenate",
1732
"iterator",
1833
"array"
1934
],
20-
"author": "Lars-Magnus Skog <[email protected]>",
21-
"license": "MIT",
22-
"devDependencies": {
23-
"coveralls": "^3.0.2",
24-
"nyc": "^12.0.2",
25-
"standard": "^11.0.1",
26-
"tape": "^4.9.1"
27-
},
2835
"engines": {
2936
"node": ">=6"
3037
}

0 commit comments

Comments
 (0)