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

Commit 45b257c

Browse files
committed
Update repository and readme
1 parent 6024df9 commit 45b257c

File tree

2 files changed

+48
-16
lines changed

2 files changed

+48
-16
lines changed

README.md

Lines changed: 45 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
11
# multileveldown
22

3-
[multilevel](https://github.com/juliangruber/multilevel) implemented using leveldowns with seamless retry support
4-
5-
```
6-
npm install multileveldown
7-
```
8-
9-
[![build status](http://img.shields.io/travis/mafintosh/multileveldown.svg?style=flat)](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+
[![npm](https://img.shields.io/npm/v/multileveldown.svg?label=&logo=npm)](https://www.npmjs.com/package/multileveldown)
7+
[![Node version](https://img.shields.io/node/v/multileveldown.svg)](https://www.npmjs.com/package/multileveldown)
8+
[![Travis](https://img.shields.io/travis/com/Level/multileveldown.svg?logo=travis&label=)](https://travis-ci.com/Level/multileveldown)
9+
[![npm](https://img.shields.io/npm/dm/multileveldown.svg?label=dl)](https://www.npmjs.com/package/multileveldown)
10+
[![Coverage Status](https://coveralls.io/repos/github/Level/multileveldown/badge.svg)](https://coveralls.io/github/Level/multileveldown)
11+
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
12+
[![Backers on Open Collective](https://opencollective.com/level/backers/badge.svg?color=orange)](#backers)
13+
[![Sponsors on Open Collective](https://opencollective.com/level/sponsors/badge.svg?color=orange)](#sponsors)
1014

1115
## Usage
1216

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.
1618

1719
First create a server
1820

@@ -81,8 +83,8 @@ var connect = function () {
8183
connect()
8284
```
8385

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
8688
stream you are missing. Please note that this might not guarantee leveldb snapshotting if you rely on that.
8789

8890
## API
@@ -111,8 +113,38 @@ Returns a new duplex client stream that you should connect with a server stream
111113

112114
#### `clientDb.createRpcStream()`
113115

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+
[![Open Collective backers](https://opencollective.com/level/backers.svg?width=890)](https://opencollective.com/level)
141+
142+
### Sponsors
143+
144+
[![Open Collective sponsors](https://opencollective.com/level/sponsors.svg?width=890)](https://opencollective.com/level)
115145

116146
## License
117147

118148
MIT
149+
150+
[level-badge]: https://leveljs.org/img/badge.svg

package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@
2525
},
2626
"repository": {
2727
"type": "git",
28-
"url": "https://github.com/mafintosh/multileveldown.git"
28+
"url": "https://github.com/Level/multileveldown.git"
2929
},
3030
"author": "Mathias Buus (@mafintosh)",
3131
"license": "MIT",
3232
"bugs": {
33-
"url": "https://github.com/mafintosh/multileveldown/issues"
33+
"url": "https://github.com/Level/multileveldown/issues"
3434
},
35-
"homepage": "https://github.com/mafintosh/multileveldown"
35+
"homepage": "https://github.com/Level/multileveldown"
3636
}

0 commit comments

Comments
 (0)