mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-07-11 06:52:30 +00:00
Add CLI tool to the README
This commit is contained in:
parent
09ad0f6492
commit
abedd8dee6
22
README.md
22
README.md
@ -6,7 +6,7 @@
|
|||||||
[](http://ipn.io)
|
[](http://ipn.io)
|
||||||
[](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)
|
[](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)
|
||||||
|
|
||||||
> Distributed, peer-to-peer database on IPFS.
|
> Distributed, peer-to-peer database for the decentralized web.
|
||||||
|
|
||||||
`orbit-db` is a serverless, distributed, peer-to-peer database. `orbit-db` uses [IPFS](https://ipfs.io) as its data storage and [IPFS Pubsub](https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go#L23) to automatically sync databases with peers. It's an eventually consistent database that uses [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) for conflict-free database merges making `orbit-db` and excellent choice for offline-first applications.
|
`orbit-db` is a serverless, distributed, peer-to-peer database. `orbit-db` uses [IPFS](https://ipfs.io) as its data storage and [IPFS Pubsub](https://github.com/ipfs/go-ipfs/blob/master/core/commands/pubsub.go#L23) to automatically sync databases with peers. It's an eventually consistent database that uses [CRDTs](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) for conflict-free database merges making `orbit-db` and excellent choice for offline-first applications.
|
||||||
|
|
||||||
@ -20,7 +20,9 @@ Data in `orbit-db` can be stored in a
|
|||||||
|
|
||||||
This is the Javascript implementation and it works both in **Node.js** and **Browsers**.
|
This is the Javascript implementation and it works both in **Node.js** and **Browsers**.
|
||||||
|
|
||||||
Try the [live demo](https://ipfs.io/ipfs/QmUETzzv9FxBwPn4H6q3i6QXTzicvV3MMuKN53JQU3yMSG/)!
|
To get started, try out the **[OrbitDB CLI](https://github.com/orbitdb/orbit-db-cli)** or check the [live demo](https://ipfs.io/ipfs/QmUETzzv9FxBwPn4H6q3i6QXTzicvV3MMuKN53JQU3yMSG/)!
|
||||||
|
|
||||||
|
<a href="https://asciinema.org/a/JdTmmdBCZarkBkPqbueicwMrG" target="_blank"><img src="https://asciinema.org/a/JdTmmdBCZarkBkPqbueicwMrG.png" width="50%"/></a>
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
@ -34,6 +36,22 @@ Try the [live demo](https://ipfs.io/ipfs/QmUETzzv9FxBwPn4H6q3i6QXTzicvV3MMuKN53J
|
|||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### CLI
|
||||||
|
|
||||||
|
For the CLI tool to manage orbit-db database, see **[OrbitDB CLI](https://github.com/orbitdb/orbit-db-cli)**.
|
||||||
|
|
||||||
|
It can be installed from Npm with:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install orbit-db-cli -g
|
||||||
|
```
|
||||||
|
|
||||||
|
### Library
|
||||||
|
|
||||||
|
`orbit-db` can be used in your Javascript programs as a module. This works both in Node.js as well as in the browsers.
|
||||||
|
|
||||||
|
To start, install the module with:
|
||||||
|
|
||||||
```
|
```
|
||||||
npm install orbit-db ipfs-daemon
|
npm install orbit-db ipfs-daemon
|
||||||
```
|
```
|
||||||
|
Loading…
x
Reference in New Issue
Block a user