|
| 1 | +Level |
| 2 | +===== |
| 3 | + |
| 4 | + |
| 5 | + |
| 6 | +Fast & simple storage - a Node.js-style LevelDB wrapper |
| 7 | +------------------------------------------------------- |
| 8 | + |
| 9 | +This is a convenience package that bundles the current release of **[LevelUP](https://github.com/rvagg/node-levelup)** and **[LevelDOWN](https://github.com/rvagg/node-leveldown)** and exposes LevelUP on its export. |
| 10 | + |
| 11 | +Use this package to avoid having to explicitly install LevelDOWN when you just want plain old LevelDB from LevelUP. |
| 12 | + |
| 13 | +```js |
| 14 | +var level = require('level') |
| 15 | + |
| 16 | +// 1) Create our database, supply location and options. |
| 17 | +// This will create or open the underlying LevelDB store. |
| 18 | +var db = level('./mydb') |
| 19 | + |
| 20 | +// 2) put a key & value |
| 21 | +db.put('name', 'Level', function (err) { |
| 22 | + if (err) return console.log('Ooops!', err) // some kind of I/O error |
| 23 | + |
| 24 | + // 3) fetch by key |
| 25 | + db.get('name', function (err, value) { |
| 26 | + if (err) return console.log('Ooops!', err) // likely the key was not found |
| 27 | + |
| 28 | + // ta da! |
| 29 | + console.log('name=' + value) |
| 30 | + }) |
| 31 | +}) |
| 32 | +``` |
| 33 | + |
| 34 | +See **[LevelUP](https://github.com/rvagg/node-levelup)** and **[LevelDOWN](https://github.com/rvagg/node-leveldown)** for more details. |
| 35 | + |
| 36 | +<a name="contributing"></a> |
| 37 | +Contributing |
| 38 | +------------ |
| 39 | + |
| 40 | +Level is an **OPEN Open Source Project**. This means that: |
| 41 | + |
| 42 | +> 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. |
| 43 | +
|
| 44 | +See the [CONTRIBUTING.md](https://github.com/Level/level/blob/master/CONTRIBUTING.md) file for more details. |
| 45 | + |
| 46 | +### Contributors |
| 47 | + |
| 48 | +Level, including LevelUP & LevelDOWN, is only possible due to the excellent work of the following contributors: |
| 49 | + |
| 50 | +<table><tbody> |
| 51 | +<tr><th align="left">Rod Vagg</th><td><a href="https://github.com/rvagg">GitHub/rvagg</a></td><td><a href="http://twitter.com/rvagg">Twitter/@rvagg</a></td></tr> |
| 52 | +<tr><th align="left">John Chesley</th><td><a href="https://github.com/chesles/">GitHub/chesles</a></td><td><a href="http://twitter.com/chesles">Twitter/@chesles</a></td></tr> |
| 53 | +<tr><th align="left">Jake Verbaten</th><td><a href="https://github.com/raynos">GitHub/raynos</a></td><td><a href="http://twitter.com/raynos2">Twitter/@raynos2</a></td></tr> |
| 54 | +<tr><th align="left">Dominic Tarr</th><td><a href="https://github.com/dominictarr">GitHub/dominictarr</a></td><td><a href="http://twitter.com/dominictarr">Twitter/@dominictarr</a></td></tr> |
| 55 | +<tr><th align="left">Max Ogden</th><td><a href="https://github.com/maxogden">GitHub/maxogden</a></td><td><a href="http://twitter.com/maxogden">Twitter/@maxogden</a></td></tr> |
| 56 | +<tr><th align="left">Lars-Magnus Skog</th><td><a href="https://github.com/ralphtheninja">GitHub/ralphtheninja</a></td><td><a href="http://twitter.com/ralphtheninja">Twitter/@ralphtheninja</a></td></tr> |
| 57 | +<tr><th align="left">David Björklund</th><td><a href="https://github.com/kesla">GitHub/kesla</a></td><td><a href="http://twitter.com/david_bjorklund">Twitter/@david_bjorklund</a></td></tr> |
| 58 | +<tr><th align="left">Julian Gruber</th><td><a href="https://github.com/juliangruber">GitHub/juliangruber</a></td><td><a href="http://twitter.com/juliangruber">Twitter/@juliangruber</a></td></tr> |
| 59 | +<tr><th align="left">Paolo Fragomeni</th><td><a href="https://github.com/hij1nx">GitHub/hij1nx</a></td><td><a href="http://twitter.com/hij1nx">Twitter/@hij1nx</a></td></tr> |
| 60 | +<tr><th align="left">Anton Whalley</th><td><a href="https://github.com/No9">GitHub/No9</a></td><td><a href="https://twitter.com/antonwhalley">Twitter/@antonwhalley</a></td></tr> |
| 61 | +<tr><th align="left">Matteo Collina</th><td><a href="https://github.com/mcollina">GitHub/mcollina</a></td><td><a href="https://twitter.com/matteocollina">Twitter/@matteocollina</a></td></tr> |
| 62 | +</tbody></table> |
| 63 | + |
| 64 | + |
| 65 | +<a name="licence"></a> |
| 66 | +Licence & copyright |
| 67 | +------------------- |
| 68 | + |
| 69 | +Copyright (c) 2012-2013 Level contributors (listed above). |
| 70 | + |
| 71 | +Level is licensed under an MIT +no-false-attribs license. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details. |
0 commit comments