Mirroristas/orbitdb
2
0
Fork 0
mirror of https://github.com/orbitdb/orbitdb.git synced 2025-03-30 15:08:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

add API to GUIDE.md

Browse Source
This commit is contained in:
anders 2020-04-17 17:58:36 -05:00 committed by Mark Robert Henderson
parent e7c890b9d0
commit f2cfaa8d1a
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
GUIDE.md
View File

@ -10,6 +10,7 @@ This guide is still being worked on and we would love to get [feedback and sugge
- [Background](#background)
- [Install](#install)
- [API](#api)
- [Setup](#setup)
- [Create a database](#create-a-database)
* [Address](#address)
@ -48,6 +49,10 @@ Install [orbit-db](https://github.com/orbitdb/orbit-db) and [ipfs](https://www.n
npm install orbit-db ipfs
```
## API
See [API.md](https://github.com/orbitdb/orbit-db/blob/master/API.md) for the full documentation.
## Setup
Require OrbitDB and IPFS in your program and create the instances: