|
1 | 1 | # multileveldown
|
2 | 2 |
|
3 |
| -[multilevel](https://github.com/juliangruber/multilevel) implemented using leveldowns with seamless retry support |
4 |
| - |
5 |
| -``` |
6 |
| -npm install multileveldown |
7 |
| -``` |
8 |
| - |
9 |
| -[](http://travis-ci.org/mafintosh/multileveldown) |
| 3 | +> [`multilevel`](https://github.com/juliangruber/multilevel) implemented using leveldowns with seamless retry support |
| 4 | +
|
| 5 | +[![level badge][level-badge]](https://github.com/Level/awesome) |
| 6 | +[](https://www.npmjs.com/package/multileveldown) |
| 7 | +[](https://www.npmjs.com/package/multileveldown) |
| 8 | +[](https://travis-ci.com/Level/multileveldown) |
| 9 | +[](https://www.npmjs.com/package/multileveldown) |
| 10 | +[](https://coveralls.io/github/Level/multileveldown) |
| 11 | +[](https://standardjs.com) |
| 12 | +[](#backers) |
| 13 | +[](#sponsors) |
10 | 14 |
|
11 | 15 | ## Usage
|
12 | 16 |
|
13 |
| -Similar to [multilevel](https://github.com/juliangruber/multilevel) you can use this to share a levelup across multiple processes |
14 |
| -over a stream. In addition multileveldown supports seamless retry so you can reconnect |
15 |
| -to a server without your read streams / puts failing etc. |
| 17 | +Similar to [`multilevel`](https://github.com/juliangruber/multilevel) you can use this to share a `levelup` database across multiple processes over a stream. In addition `multileveldown` supports seamless retry so you can reconnect to a server without your read streams / puts failing etc. |
16 | 18 |
|
17 | 19 | First create a server
|
18 | 20 |
|
@@ -81,8 +83,8 @@ var connect = function () {
|
81 | 83 | connect()
|
82 | 84 | ```
|
83 | 85 |
|
84 |
| -multileveldown will now make sure to retry your pending operations when you reconnect. If you create a read stream |
85 |
| -and your connection fails half way through reading that stream multileveldown makes sure to only retry the part of the |
| 86 | +`multileveldown` will now make sure to retry your pending operations when you reconnect. If you create a read stream |
| 87 | +and your connection fails half way through reading that stream `multileveldown` makes sure to only retry the part of the |
86 | 88 | stream you are missing. Please note that this might not guarantee leveldb snapshotting if you rely on that.
|
87 | 89 |
|
88 | 90 | ## API
|
@@ -111,8 +113,38 @@ Returns a new duplex client stream that you should connect with a server stream
|
111 | 113 |
|
112 | 114 | #### `clientDb.createRpcStream()`
|
113 | 115 |
|
114 |
| -Just an alias to `.connect` for [multilevel](https://github.com/juliangruber/multilevel) API compatibility. |
| 116 | +Just an alias to `.connect` for [`multilevel`](https://github.com/juliangruber/multilevel) API compatibility. |
| 117 | + |
| 118 | +## Install |
| 119 | + |
| 120 | +With [npm](https://npmjs.org) do: |
| 121 | + |
| 122 | +``` |
| 123 | +npm i multileveldown |
| 124 | +``` |
| 125 | + |
| 126 | +## Contributing |
| 127 | + |
| 128 | +[`Level/multileveldown`](https://github.com/Level/multileveldown) is an **OPEN Open Source Project**. This means that: |
| 129 | + |
| 130 | +> 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. |
| 131 | +
|
| 132 | +See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details. |
| 133 | + |
| 134 | +## Donate |
| 135 | + |
| 136 | +To sustain [`Level`](https://github.com/Level) and its activities, become a backer or sponsor on [Open Collective](https://opencollective.com/level). Your logo or avatar will be displayed on our 28+ [GitHub repositories](https://github.com/Level) and [npm](https://www.npmjs.com/) packages. 💖 |
| 137 | + |
| 138 | +### Backers |
| 139 | + |
| 140 | +[](https://opencollective.com/level) |
| 141 | + |
| 142 | +### Sponsors |
| 143 | + |
| 144 | +[](https://opencollective.com/level) |
115 | 145 |
|
116 | 146 | ## License
|
117 | 147 |
|
118 | 148 | MIT
|
| 149 | + |
| 150 | +[level-badge]: https://leveljs.org/img/badge.svg |
0 commit comments