From 33eb8458d0072981a551dcd2dd135e12ae222157 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 08:07:33 +0200 Subject: [PATCH 01/12] update package.json description and keywords --- package.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6ab80ef..1252247 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "level-js", "version": "3.0.0-rc1", - "description": "leveldown/leveldb library for browsers using IndexedDB", + "description": "An abstract-leveldown compliant store on top of IndexedDB", "main": "index.js", "scripts": { "test": "standard && airtap --local --no-coverage test/index.js", @@ -21,7 +21,9 @@ }, "keywords": [ "level", - "leveldb" + "leveldb", + "indexeddb", + "abstract-leveldown" ], "author": "max ogden", "license": "MIT", From c06a3c396b72fb9afee8336880cf8dcd3ba60374 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 08:13:58 +0200 Subject: [PATCH 02/12] reorder package.json --- package.json | 46 +++++++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/package.json b/package.json index 1252247..6a5c1fd 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,8 @@ "name": "level-js", "version": "3.0.0-rc1", "description": "An abstract-leveldown compliant store on top of IndexedDB", + "author": "max ogden", + "license": "MIT", "main": "index.js", "scripts": { "test": "standard && airtap --local --no-coverage test/index.js", @@ -15,23 +17,13 @@ "CHANGELOG.md", "sauce-labs.svg" ], - "repository": { - "type": "git", - "url": "git@github.com:Level/level-js.git" + "browser": { + "./util/immediate.js": "./util/immediate-browser.js" }, - "keywords": [ - "level", - "leveldb", - "indexeddb", - "abstract-leveldown" - ], - "author": "max ogden", - "license": "MIT", - "devDependencies": { - "airtap": "0.0.7", - "buffer": "~5.1.0", - "standard": "^11.0.1", - "tape": "^4.0.0" + "standard": { + "ignore": [ + "test/util/idb-shim.js" + ] }, "dependencies": { "abstract-leveldown": "~5.0.0", @@ -40,12 +32,20 @@ "ltgt": "^2.1.2", "typedarray-to-buffer": "~3.1.5" }, - "browser": { - "./util/immediate.js": "./util/immediate-browser.js" + "devDependencies": { + "airtap": "0.0.7", + "buffer": "~5.1.0", + "standard": "^11.0.1", + "tape": "^4.0.0" }, - "standard": { - "ignore": [ - "test/util/idb-shim.js" - ] - } + "repository": { + "type": "git", + "url": "git@github.com:Level/level-js.git" + }, + "keywords": [ + "level", + "leveldb", + "indexeddb", + "abstract-leveldown" + ] } From 8f6d6d3cccfd3cdae9a7353ca0fe02a91e64b1cc Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 08:16:08 +0200 Subject: [PATCH 03/12] copyright 2012-present --- LICENSE.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index cd13205..d868a16 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # The MIT License (MIT) -## Copyright (c) 2012-2018 `level-js` contributors +## Copyright (c) 2012-present `level-js` contributors *`level-js` contributors listed at * diff --git a/README.md b/README.md index a51b6b9..bcbfa11 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http ## License -Copyright (c) 2012-present `level-js` [contributors](https://github.com/level/community#contributors). +Copyright © 2012-present `level-js` [contributors](https://github.com/level/community#contributors). `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. From 57391f4abb351d35b9dae987611f35c029174118 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 08:22:13 +0200 Subject: [PATCH 04/12] add original copyright owner --- LICENSE.md | 2 +- README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index d868a16..ca11882 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # The MIT License (MIT) -## Copyright (c) 2012-present `level-js` contributors +## Copyright (c) 2012-present Max Ogden and `level-js` contributors *`level-js` contributors listed at * diff --git a/README.md b/README.md index bcbfa11..b2ff492 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http ## License -Copyright © 2012-present `level-js` [contributors](https://github.com/level/community#contributors). +Copyright © 2012-present [Max Ogden](https://github.com/maxogden) and `level-js` [contributors](https://github.com/level/community#contributors). `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. From 7f699be949cbb92926a45da88ae229f7c3a1b0a7 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 14:39:41 +0200 Subject: [PATCH 05/12] remove collaborators.md --- collaborators.md | 10 ---------- 1 file changed, 10 deletions(-) delete mode 100644 collaborators.md diff --git a/collaborators.md b/collaborators.md deleted file mode 100644 index 9dc7a2d..0000000 --- a/collaborators.md +++ /dev/null @@ -1,10 +0,0 @@ -## Collaborators - -`level-js` is only possible due to the excellent work of the following collaborators: - - - - - - -
juliangruberGitHub/juliangruber
maxogdenGitHub/maxogden
mcollinaGitHub/mcollina
JamesKyburzGitHub/JamesKyburz
nolanlawsonGitHub/nolanlawson
From 28e5187413e661650703578e6897c2243cf3dace Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 22:40:17 +0200 Subject: [PATCH 06/12] try out remark-cli with remark-gh-contributors --- package.json | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 6a5c1fd..bcf02c7 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "main": "index.js", "scripts": { "test": "standard && airtap --local --no-coverage test/index.js", - "test-browsers": "standard && airtap --sauce-connect --loopback airtap.local --no-coverage test/index.js" + "test-browsers": "standard && airtap --sauce-connect --loopback airtap.local --no-coverage test/index.js", + "remark": "remark README.md -o" }, "files": [ "index.js", @@ -35,9 +36,17 @@ "devDependencies": { "airtap": "0.0.7", "buffer": "~5.1.0", + "level-community": "^2.1.1", + "remark-cli": "^5.0.0", + "remark-gh-contributors": "^0.0.1", "standard": "^11.0.1", "tape": "^4.0.0" }, + "remarkConfig": { + "plugins": { + "remark-gh-contributors": "level-community" + } + }, "repository": { "type": "git", "url": "git@github.com:Level/level-js.git" From 4b05e47606a904163835ac30f4f85200fe0113df Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 22:47:11 +0200 Subject: [PATCH 07/12] simplify license description --- LICENSE.md | 4 +--- README.md | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/LICENSE.md b/LICENSE.md index ca11882..a0cdf93 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,8 +1,6 @@ # The MIT License (MIT) -## Copyright (c) 2012-present Max Ogden and `level-js` contributors - -*`level-js` contributors listed at * +**Copyright © 2012-present Max Ogden and Contributors** 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: diff --git a/README.md b/README.md index b2ff492..99096b4 100644 --- a/README.md +++ b/README.md @@ -91,8 +91,6 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http ## License -Copyright © 2012-present [Max Ogden](https://github.com/maxogden) and `level-js` [contributors](https://github.com/level/community#contributors). - -`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. +MIT © 2012-present [Max Ogden](https://github.com/maxogden) and Contributors. See included [`LICENSE.md`](./LICENSE.md) for more details. [level-badge]: http://leveldb.org/img/badge.svg From 429f11ebd4031edc7851dfbadba90f705b2f97ef Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 3 Jun 2018 22:48:14 +0200 Subject: [PATCH 08/12] run remark (has side effects) --- README.md | 34 +++++++++++++++++++++++++--------- 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 99096b4..8b61033 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ Here are the goals of `level-js`: -- Store large amounts of data in modern browsers -- Pass the full `abstract-leveldown` test suite -- Support [Buffer](https://nodejs.org/api/buffer.html) values (in all target environments) -- Support all key types of IndexedDB Second Edition, including binary keys (depends on environment) -- Support all value types of the structured clone algorithm (depends on environment) except for `null` and `undefined` -- Be as fast as possible -- Sync with [multilevel](https://github.com/juliangruber/multilevel) over either ASCII or binary transports. +- Store large amounts of data in modern browsers +- Pass the full `abstract-leveldown` test suite +- Support [Buffer](https://nodejs.org/api/buffer.html) values (in all target environments) +- Support all key types of IndexedDB Second Edition, including binary keys (depends on environment) +- Support all value types of the structured clone algorithm (depends on environment) except for `null` and `undefined` +- Be as fast as possible +- Sync with [multilevel](https://github.com/juliangruber/multilevel) over either ASCII or binary transports. 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). @@ -61,14 +61,15 @@ This library is best used with [browserify](http://browserify.org). ## API ### `db = leveljs(location[, options])` + 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`. #### `options` The optional `options` argument may contain: -* `prefix` *(string, default: `'level-js-'`)*: Prefix for `IDBDatabase` name. -* `version` *(string | number, default: `1`)*: The version to open the database with. +- `prefix` _(string, default: `'level-js-'`)_: Prefix for `IDBDatabase` name. +- `version` _(string | number, default: `1`)_: The version to open the database with. See [`IDBFactory#open`](https://developer.mozilla.org/en-US/docs/Web/API/IDBFactory/open) for more details. @@ -83,6 +84,21 @@ npm test It will print out a URL to open in a browser of choice. +## Contributors + +| Name | GitHub | +| ----------------------- | ------------------------------------------------------ | +| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | +| **Maxwell ogden** | [**@maxogden**](https://github.com/maxogden) | +| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | +| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | +| **Nolan Lawson** | [**@nolanlawson**](https://github.com/nolanlawson) | +| **Josh** | [**@qs44**](https://github.com/qs44) | +| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | +| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | +| **Kyle Robinson Young** | [**@shama**](https://github.com/shama) | +| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | + ## Big Thanks Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](https://saucelabs.com). From d9208d341b47094641551477b4d43d31340f079a Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sat, 9 Jun 2018 12:56:52 +0200 Subject: [PATCH 09/12] switch to remark-git-contributors and level-community@3 --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index bcf02c7..87d23a2 100644 --- a/package.json +++ b/package.json @@ -36,15 +36,15 @@ "devDependencies": { "airtap": "0.0.7", "buffer": "~5.1.0", - "level-community": "^2.1.1", + "level-community": "~3.0.0", "remark-cli": "^5.0.0", - "remark-gh-contributors": "^0.0.1", + "remark-git-contributors": "~0.2.0", "standard": "^11.0.1", "tape": "^4.0.0" }, "remarkConfig": { "plugins": { - "remark-gh-contributors": "level-community" + "remark-git-contributors": "level-community" } }, "repository": { From 5ed34921c6d930cc351d2a1ba98fef61ae4bd6b6 Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 10 Jun 2018 11:24:16 +0200 Subject: [PATCH 10/12] move contributors to contributors.md and run remark --- CONTRIBUTORS.md | 22 ++++++++++++++++++++++ LICENSE.md | 2 +- README.md | 17 +---------------- package.json | 4 ++-- 4 files changed, 26 insertions(+), 19 deletions(-) create mode 100644 CONTRIBUTORS.md diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 0000000..6575824 --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,22 @@ +# Contributors + +| Name | GitHub | Social | +| ----------------------- | ------------------------------------------------------ | --------------------------------------------------------------- | +| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) | +| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) | +| **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) | +| **Nolan Lawson** | [**@nolanlawson**](https://github.com/nolanlawson) | [**@nolan@toot.cafe**](https://toot.cafe/@nolan) | +| **Josh** | [**@qs44**](https://github.com/qs44) | | +| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) | +| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | [**@dominictarr@twitter**](https://twitter.com/dominictarr) | +| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) | +| **Kyle Robinson Young** | [**@shama**](https://github.com/shama) | [**@shamakry@twitter**](https://twitter.com/shamakry) | +| **Mathias Buus** | [**@mafintosh**](https://github.com/mafintosh) | [**@mafintosh@twitter**](https://twitter.com/mafintosh) | +| **James Halliday** | [**@substack**](https://github.com/substack) | [**@substack@twitter**](https://twitter.com/substack) | +| **Ryan Ramage** | [**@ryanramage**](https://github.com/ryanramage) | | +| **James Kyburz** | [**@jameskyburz**](https://github.com/jameskyburz) | [**@jameskyburz@twitter**](https://twitter.com/jameskyburz) | +| **Yoshua Wuyts** | [**@yoshuawuyts**](https://github.com/yoshuawuyts) | [**@yoshuawuyts@twitter**](https://twitter.com/yoshuawuyts) | +| **Calvin Metcalf** | [**@calvinmetcalf**](https://github.com/calvinmetcalf) | | +| **Nicholas Westlake** | [**@nrw**](https://github.com/nrw) | | +| **Bryce Baril** | [**@brycebaril**](https://github.com/brycebaril) | [**@brycebaril@twitter**](https://twitter.com/brycebaril) | diff --git a/LICENSE.md b/LICENSE.md index a0cdf93..240b0b9 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # The MIT License (MIT) -**Copyright © 2012-present Max Ogden and Contributors** +**Copyright © 2012-present Max Ogden 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: diff --git a/README.md b/README.md index 8b61033..d978128 100644 --- a/README.md +++ b/README.md @@ -84,21 +84,6 @@ npm test It will print out a URL to open in a browser of choice. -## Contributors - -| Name | GitHub | -| ----------------------- | ------------------------------------------------------ | -| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | -| **Maxwell ogden** | [**@maxogden**](https://github.com/maxogden) | -| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | -| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | -| **Nolan Lawson** | [**@nolanlawson**](https://github.com/nolanlawson) | -| **Josh** | [**@qs44**](https://github.com/qs44) | -| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | -| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | -| **Kyle Robinson Young** | [**@shama**](https://github.com/shama) | -| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | - ## Big Thanks Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](https://saucelabs.com). @@ -107,6 +92,6 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http ## License -MIT © 2012-present [Max Ogden](https://github.com/maxogden) and Contributors. See included [`LICENSE.md`](./LICENSE.md) for more details. +MIT © 2012-present [Max Ogden](https://github.com/maxogden) and [Contributors](./CONTRIBUTORS.md). See included [`LICENSE.md`](./LICENSE.md) for more details. [level-badge]: http://leveldb.org/img/badge.svg diff --git a/package.json b/package.json index 87d23a2..e63b753 100644 --- a/package.json +++ b/package.json @@ -8,13 +8,13 @@ "scripts": { "test": "standard && airtap --local --no-coverage test/index.js", "test-browsers": "standard && airtap --sauce-connect --loopback airtap.local --no-coverage test/index.js", - "remark": "remark README.md -o" + "remark": "remark README.md CONTRIBUTORS.md -o" }, "files": [ "index.js", "iterator.js", "util", - "collaborators.md", + "CONTRIBUTORS.md", "CHANGELOG.md", "sauce-labs.svg" ], From a8cfe11327af8403a3cc1cca596d3cc3a3fa8a5d Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Sun, 10 Jun 2018 11:28:05 +0200 Subject: [PATCH 11/12] even more succinct license section (bringer us closer to remark-license) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d978128..c7734a5 100644 --- a/README.md +++ b/README.md @@ -92,6 +92,6 @@ Cross-browser Testing Platform and Open Source ♥ Provided by [Sauce Labs](http ## License -MIT © 2012-present [Max Ogden](https://github.com/maxogden) and [Contributors](./CONTRIBUTORS.md). See included [`LICENSE.md`](./LICENSE.md) for more details. +[MIT](./LICENSE.md) © 2012-present [Max Ogden](https://github.com/maxogden) and [Contributors](./CONTRIBUTORS.md). [level-badge]: http://leveldb.org/img/badge.svg From 9b2d8ee1ca4d054a49ab88fa1e3a8c24882dc99e Mon Sep 17 00:00:00 2001 From: Vincent Weevers Date: Fri, 15 Jun 2018 11:35:32 +0200 Subject: [PATCH 12/12] link to maxogden --- LICENSE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE.md b/LICENSE.md index 240b0b9..00bcc40 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ # The MIT License (MIT) -**Copyright © 2012-present Max Ogden and [Contributors](./CONTRIBUTORS.md)** +**Copyright © 2012-present [Max Ogden](https://github.com/maxogden) 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: