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

Commit 9d5ec5c

Browse files
authored
Docs (#141)
* update package.json description and keywords * reorder package.json * copyright 2012-present * add original copyright owner * remove collaborators.md * try out remark-cli with remark-gh-contributors * simplify license description * run remark (has side effects) * switch to remark-git-contributors and level-community@3 * move contributors to contributors.md and run remark * even more succinct license section (bringer us closer to remark-license) * link to maxogden
1 parent 7017edd commit 9d5ec5c

5 files changed

Lines changed: 69 additions & 49 deletions

File tree

CONTRIBUTORS.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributors
2+
3+
| Name | GitHub | Social |
4+
| ----------------------- | ------------------------------------------------------ | --------------------------------------------------------------- |
5+
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |
6+
| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) |
7+
| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) |
8+
| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) |
9+
| **Nolan Lawson** | [**@nolanlawson**](https://github.com/nolanlawson) | [**@nolan@toot.cafe**](https://toot.cafe/@nolan) |
10+
| **Josh** | [**@qs44**](https://github.com/qs44) | |
11+
| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) |
12+
| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | [**@dominictarr@twitter**](https://twitter.com/dominictarr) |
13+
| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) |
14+
| **Kyle Robinson Young** | [**@shama**](https://github.com/shama) | [**@shamakry@twitter**](https://twitter.com/shamakry) |
15+
| **Mathias Buus** | [**@mafintosh**](https://github.com/mafintosh) | [**@mafintosh@twitter**](https://twitter.com/mafintosh) |
16+
| **James Halliday** | [**@substack**](https://github.com/substack) | [**@substack@twitter**](https://twitter.com/substack) |
17+
| **Ryan Ramage** | [**@ryanramage**](https://github.com/ryanramage) | |
18+
| **James Kyburz** | [**@jameskyburz**](https://github.com/jameskyburz) | [**@jameskyburz@twitter**](https://twitter.com/jameskyburz) |
19+
| **Yoshua Wuyts** | [**@yoshuawuyts**](https://github.com/yoshuawuyts) | [**@yoshuawuyts@twitter**](https://twitter.com/yoshuawuyts) |
20+
| **Calvin Metcalf** | [**@calvinmetcalf**](https://github.com/calvinmetcalf) | |
21+
| **Nicholas Westlake** | [**@nrw**](https://github.com/nrw) | |
22+
| **Bryce Baril** | [**@brycebaril**](https://github.com/brycebaril) | [**@brycebaril@twitter**](https://twitter.com/brycebaril) |

LICENSE.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# The MIT License (MIT)
22

3-
## Copyright (c) 2012-2018 `level-js` contributors
4-
5-
*`level-js` contributors listed at <https://github.com/level/community#contributors>*
3+
**Copyright © 2012-present [Max Ogden](https://github.com/maxogden) and [Contributors](./CONTRIBUTORS.md).**
64

75
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:
86

README.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@
1313

1414
Here are the goals of `level-js`:
1515

16-
- Store large amounts of data in modern browsers
17-
- Pass the full `abstract-leveldown` test suite
18-
- Support [Buffer](https://nodejs.org/api/buffer.html) values (in all target environments)
19-
- Support all key types of IndexedDB Second Edition, including binary keys (depends on environment)
20-
- Support all value types of the structured clone algorithm (depends on environment) except for `null` and `undefined`
21-
- Be as fast as possible
22-
- Sync with [multilevel](https://github.com/juliangruber/multilevel) over either ASCII or binary transports.
16+
- Store large amounts of data in modern browsers
17+
- Pass the full `abstract-leveldown` test suite
18+
- Support [Buffer](https://nodejs.org/api/buffer.html) values (in all target environments)
19+
- Support all key types of IndexedDB Second Edition, including binary keys (depends on environment)
20+
- Support all value types of the structured clone algorithm (depends on environment) except for `null` and `undefined`
21+
- Be as fast as possible
22+
- Sync with [multilevel](https://github.com/juliangruber/multilevel) over either ASCII or binary transports.
2323

2424
Being `abstract-leveldown` compliant means you can use many of the [Level modules](https://github.com/Level/awesome/) on top of this library. For some demos of it working, see @brycebaril's presentation [Path of the NodeBases Jedi](http://brycebaril.github.io/nodebase_jedi/#/vanilla).
2525

@@ -61,14 +61,15 @@ This library is best used with [browserify](http://browserify.org).
6161
## API
6262

6363
### `db = leveljs(location[, options])`
64+
6465
Returns a new `leveljs` instance. `location` is the string name of the [`IDBDatabase`](https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase) to be opened, as well as the object store within that database. The database name will be prefixed with `options.prefix`.
6566

6667
#### `options`
6768

6869
The optional `options` argument may contain:
6970

70-
* `prefix` *(string, default: `'level-js-'`)*: Prefix for `IDBDatabase` name.
71-
* `version` *(string | number, default: `1`)*: The version to open the database with.
71+
- `prefix` _(string, default: `'level-js-'`)_: Prefix for `IDBDatabase` name.
72+
- `version` _(string | number, default: `1`)_: The version to open the database with.
7273

7374
See [`IDBFactory#open`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory/open) for more details.
7475

@@ -91,8 +92,6 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http
9192

9293
## License
9394

94-
Copyright (c) 2012-present `level-js` [contributors](https://github.com/level/community#contributors).
95-
96-
`level-js` 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.
95+
[MIT](./LICENSE.md) © 2012-present [Max Ogden](https://github.com/maxogden) and [Contributors](./CONTRIBUTORS.md).
9796

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

collaborators.md

Lines changed: 0 additions & 10 deletions
This file was deleted.

package.json

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
11
{
22
"name": "level-js",
33
"version": "3.0.0-rc1",
4-
"description": "leveldown/leveldb library for browsers using IndexedDB",
4+
"description": "An abstract-leveldown compliant store on top of IndexedDB",
5+
"author": "max ogden",
6+
"license": "MIT",
57
"main": "index.js",
68
"scripts": {
79
"test": "standard && airtap --local --no-coverage test/index.js",
8-
"test-browsers": "standard && airtap --sauce-connect --loopback airtap.local --no-coverage test/index.js"
10+
"test-browsers": "standard && airtap --sauce-connect --loopback airtap.local --no-coverage test/index.js",
11+
"remark": "remark README.md CONTRIBUTORS.md -o"
912
},
1013
"files": [
1114
"index.js",
1215
"iterator.js",
1316
"util",
14-
"collaborators.md",
17+
"CONTRIBUTORS.md",
1518
"CHANGELOG.md",
1619
"sauce-labs.svg"
1720
],
18-
"repository": {
19-
"type": "git",
20-
"url": "git@github.com:Level/level-js.git"
21+
"browser": {
22+
"./util/immediate.js": "./util/immediate-browser.js"
2123
},
22-
"keywords": [
23-
"level",
24-
"leveldb"
25-
],
26-
"author": "max ogden",
27-
"license": "MIT",
28-
"devDependencies": {
29-
"airtap": "0.0.7",
30-
"buffer": "~5.1.0",
31-
"standard": "^11.0.1",
32-
"tape": "^4.0.0"
24+
"standard": {
25+
"ignore": [
26+
"test/util/idb-shim.js"
27+
]
3328
},
3429
"dependencies": {
3530
"abstract-leveldown": "~5.0.0",
@@ -38,12 +33,28 @@
3833
"ltgt": "^2.1.2",
3934
"typedarray-to-buffer": "~3.1.5"
4035
},
41-
"browser": {
42-
"./util/immediate.js": "./util/immediate-browser.js"
36+
"devDependencies": {
37+
"airtap": "0.0.7",
38+
"buffer": "~5.1.0",
39+
"level-community": "~3.0.0",
40+
"remark-cli": "^5.0.0",
41+
"remark-git-contributors": "~0.2.0",
42+
"standard": "^11.0.1",
43+
"tape": "^4.0.0"
4344
},
44-
"standard": {
45-
"ignore": [
46-
"test/util/idb-shim.js"
47-
]
48-
}
45+
"remarkConfig": {
46+
"plugins": {
47+
"remark-git-contributors": "level-community"
48+
}
49+
},
50+
"repository": {
51+
"type": "git",
52+
"url": "git@github.com:Level/level-js.git"
53+
},
54+
"keywords": [
55+
"level",
56+
"leveldb",
57+
"indexeddb",
58+
"abstract-leveldown"
59+
]
4960
}

0 commit comments

Comments
 (0)