mirror of
https://github.com/orbitdb/orbitdb.git
synced 2025-07-08 13:32:29 +00:00
Update documentation
This commit is contained in:
parent
a7d60e2d9a
commit
0773c22c48
4
API.md
4
API.md
@ -151,7 +151,9 @@ const db = await orbitdb.keyvalue(anotherkvdb.address)
|
|||||||
```javascript
|
```javascript
|
||||||
await db.set('hello', { name: 'Friend' })
|
await db.set('hello', { name: 'Friend' })
|
||||||
```
|
```
|
||||||
|
|
||||||
|
*set() is an alias of put(). They both work the same.*
|
||||||
|
|
||||||
#### get(key)
|
#### get(key)
|
||||||
```javascript
|
```javascript
|
||||||
const value = db.get('hello')
|
const value = db.get('hello')
|
||||||
|
@ -8,7 +8,7 @@
|
|||||||
|
|
||||||
> A peer-to-peer database for the decentralized web
|
> A 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` an excellent choice for decentralized apps (dApps), blockchain applications and offline-first web applications.
|
||||||
|
|
||||||
Data in `orbit-db` can be stored in a
|
Data in `orbit-db` can be stored in a
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user