Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-06-05 21:56:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
haad 2017-03-31 11:53:01 +02:00
parent afb7a5689b
commit f27973d16f
1 changed files with 26 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
README.md
View File

@ -1,7 +1,7 @@
# orbit-db
[![npm version](https://badge.fury.io/js/orbit-db.svg)](https://badge.fury.io/js/orbit-db)
[![CircleCI Status](https://circleci.com/gh/haadcode/orbit-db.svg?style=shield)](https://circleci.com/gh/haadcode/orbit-db)
[![CircleCI Status](https://circleci.com/gh/orbitdb/orbit-db.svg?style=shield)](https://circleci.com/gh/orbitdb/orbit-db)
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
[![Project Status](https://badge.waffle.io/haadcode/orbit.svg?label=In%20Progress&title=In%20Progress)](https://waffle.io/haadcode/orbit?source=haadcode%2Forbit-db,haadcode%2Forbit-db-counterstore,haadcode%2Forbit-db-eventstore,haadcode%2Forbit-db-feedstore,haadcode%2Forbit-db-kvstore,haadcode%2Forbit-db-store,haadcode%2Fipfs-log)
@ -11,11 +11,11 @@
Data in `orbit-db` can be stored in a
- **[Key-Value Store](https://github.com/haadcode/orbit-db-kvstore)**
- **[Eventlog](https://github.com/haadcode/orbit-db-eventstore)** (append-only log)
- **[Feed](https://github.com/haadcode/orbit-db-feedstore)** (add and remove log)
- **[Documents](https://github.com/shamb0t/orbit-db-docstore)** (indexed by custom fields)
- **[Counters](https://github.com/haadcode/orbit-db-counterstore)**
- **[Key-Value Store](https://github.com/orbitdb/orbit-db-kvstore)**
- **[Eventlog](https://github.com/orbitdb/orbit-db-eventstore)** (append-only log)
- **[Feed](https://github.com/orbitdb/orbit-db-feedstore)** (add and remove log)
- **[Documents](https://github.com/orbitdb/orbit-db-docstore)** (indexed by custom fields)
- **[Counters](https://github.com/orbitdb/orbit-db-counterstore)**
This is the Javascript implementation and it works both in **Node.js** and **Browsers**.
@ -57,28 +57,28 @@ ipfs.on('ready', (e) => {
})
```
*For more details, see examples for [kvstore](https://github.com/haadcode/orbit-db-kvstore#usage), [eventlog](https://github.com/haadcode/orbit-db-eventstore#usage), [feed](https://github.com/haadcode/orbit-db-feedstore#usage), [docstore](https://github.com/shamb0t/orbit-db-docstore#usage) and [counter](https://github.com/haadcode/orbit-db-counterstore#usage).*
*For more details, see examples for [kvstore](https://github.com/orbitdb/orbit-db-kvstore#usage), [eventlog](https://github.com/orbitdb/orbit-db-eventstore#usage), [feed](https://github.com/orbitdb/orbit-db-feedstore#usage), [docstore](https://github.com/shamb0t/orbit-db-docstore#usage) and [counter](https://github.com/orbitdb/orbit-db-counterstore#usage).*
## API
See [API documentation](https://github.com/haadcode/orbit-db/blob/master/API.md#orbit-db-api-documentation) for the full documentation.
See [API documentation](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbit-db-api-documentation) for the full documentation.
- [Getting Started](https://github.com/haadcode/orbit-db/blob/master/API.md#getting-started)
- [orbitdb](https://github.com/haadcode/orbit-db/blob/master/API.md#orbitdb)
- [kvstore(name)](https://github.com/haadcode/orbit-db/blob/master/API.md#kvstorename)
- [eventlog(name)](https://github.com/haadcode/orbit-db/blob/master/API.md#eventlogname)
- [feed(name)](https://github.com/haadcode/orbit-db/blob/master/API.md#feedname)
- [docstore(name, options)](https://github.com/haadcode/orbit-db/blob/master/API.md#docstorename-options)
- [counter(name)](https://github.com/haadcode/orbit-db/blob/master/API.md#countername)
- [disconnect()](https://github.com/haadcode/orbit-db/blob/master/API.md#disconnect)
- [events](https://github.com/haadcode/orbit-db/blob/master/API.md#events)
- [Getting Started](https://github.com/orbitdb/orbit-db/blob/master/API.md#getting-started)
- [orbitdb](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdb)
- [kvstore(name)](https://github.com/orbitdb/orbit-db/blob/master/API.md#kvstorename)
- [eventlog(name)](https://github.com/orbitdb/orbit-db/blob/master/API.md#eventlogname)
- [feed(name)](https://github.com/orbitdb/orbit-db/blob/master/API.md#feedname)
- [docstore(name, options)](https://github.com/orbitdb/orbit-db/blob/master/API.md#docstorename-options)
- [counter(name)](https://github.com/orbitdb/orbit-db/blob/master/API.md#countername)
- [disconnect()](https://github.com/orbitdb/orbit-db/blob/master/API.md#disconnect)
- [events](https://github.com/orbitdb/orbit-db/blob/master/API.md#events)
## Examples
### Install dependencies
```
git clone https://github.com/haadcode/orbit-db.git
git clone https://github.com/orbitdb/orbit-db.git
cd orbit-db
npm install
```
@ -90,9 +90,9 @@ npm run build:examples
npm run examples:browser
```
<img src="https://raw.githubusercontent.com/haadcode/orbit-db/feat/ipfs-pubsub/screenshots/orbit-db-demo1.gif" width="33%">
<img src="https://raw.githubusercontent.com/orbitdb/orbit-db/feat/ipfs-pubsub/screenshots/orbit-db-demo1.gif" width="33%">
Check the code in [examples/browser/browser.html](https://github.com/haadcode/orbit-db/blob/master/examples/browser/browser.html).
Check the code in [examples/browser/browser.html](https://github.com/orbitdb/orbit-db/blob/master/examples/browser/browser.html).
### Node.js example
@ -100,18 +100,18 @@ Check the code in [examples/browser/browser.html](https://github.com/haadcode/or
npm run examples:node
```
<img src="https://raw.githubusercontent.com/haadcode/orbit-db/feat/ipfs-pubsub/screenshots/orbit-db-demo3.gif" width="66%">
<img src="https://raw.githubusercontent.com/orbitdb/orbit-db/feat/ipfs-pubsub/screenshots/orbit-db-demo3.gif" width="66%">
**Eventlog**
Check the code in [examples/eventlog.js](https://github.com/haadcode/orbit-db/blob/master/examples/eventlog.js) and run it with:
Check the code in [examples/eventlog.js](https://github.com/orbitdb/orbit-db/blob/master/examples/eventlog.js) and run it with:
```
LOG=debug node examples/eventlog.js
```
**Key-Value**
Check the code in [examples/keyvalue.js](https://github.com/haadcode/orbit-db/blob/master/examples/keystore.js) and run it with:
Check the code in [examples/keyvalue.js](https://github.com/orbitdb/orbit-db/blob/master/examples/keystore.js) and run it with:
```
LOG=debug node examples/keyvalue.js
```
@ -135,7 +135,7 @@ node examples/benchmark.js
## Background
Check out a visualization of the data flow at https://github.com/haadcode/proto2 or a live demo: http://celebdil.benet.ai:8080/ipfs/Qmezm7g8mBpWyuPk6D84CNcfLKJwU6mpXuEN5GJZNkX3XK/.
Check out a visualization of the data flow at https://github.com/haadcode/proto2.
**TODO**
@ -148,9 +148,9 @@ Check out a visualization of the data flow at https://github.com/haadcode/proto2
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
I would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach me on Twitter [@haadcode](https://twitter.com/haadcode) or on IRC #ipfs on Freenode, or in the comments of the [issues section](https://github.com/haadcode/orbit-db/issues).
We would be happy to accept PRs! If you want to work on something, it'd be good to talk beforehand to make sure nobody else is working on it. You can reach us on IRC #ipfs on Freenode, or in the comments of the [issues section](https://github.com/orbitdb/orbit-db/issues).
A good place to start are the issues labelled ["help wanted"](https://github.com/haadcode/orbit-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc) or the project's [status board](https://waffle.io/haadcode/orbit-db).
A good place to start are the issues labelled ["help wanted"](https://github.com/orbitdb/orbit-db/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22+sort%3Areactions-%2B1-desc) or the project's [status board](https://waffle.io/orbitdb/orbit-db).
## License