From 51d0c2c3e9e9a5cc21090716a66b0a09d804be7d Mon Sep 17 00:00:00 2001 From: Kia <1823355+mistakia@users.noreply.github.com> Date: Fri, 20 Jul 2018 08:40:46 -0400 Subject: [PATCH] docs(readme): remove api list keep README.md concise --- README.md | 55 +------------------------------------------------------ 1 file changed, 1 insertion(+), 54 deletions(-) diff --git a/README.md b/README.md index 663db82..da4b272 100644 --- a/README.md +++ b/README.md @@ -124,7 +124,7 @@ const db = await orbitdb.log('hello') ## API -See [API documentation](https://github.com/orbitdb/orbit-db/blob/master/API.md) for the full documentation. +See [API.md](https://github.com/orbitdb/orbit-db/blob/master/API.md) for the full documentation. ### constructor(ipfs, [directory], [options]) ```javascript @@ -140,59 +140,6 @@ After creating an `OrbitDB` instance , you can access the different data stores. *For further details, see usage 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/orbitdb/orbit-db-docstore#usage) and [counter](https://github.com/orbitdb/orbit-db-counterstore#usage).* -**Public OrbitDB Instance Methods** -- [orbitdb.create(name|address, type, [options])](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbcreatename-type-options) -- [orbitdb.open(name|address, [options])](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbopenaddress-options) -- [orbitdb.disconnect()](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbdisconnect) -- [orbitdb.stop()](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbstop) -- [orbitdb.keyvalue(name|address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbkeyvaluenameaddress) - - [kv.put(key, value)](https://github.com/orbitdb/orbit-db/blob/master/API.md#putkey-value) - - [kv.set(key, value)](https://github.com/orbitdb/orbit-db/blob/master/API.md#setkey-value) - - [kv.get(key)](https://github.com/orbitdb/orbit-db/blob/master/API.md#getKey) -- [orbitdb.log(name|address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdblognameaddress) - - [log.add(event)](https://github.com/orbitdb/orbit-db/blob/master/API.md#addevent) - - [log.get(hash)](https://github.com/orbitdb/orbit-db/blob/master/API.md#gethash) - - [log.iterator([options])](https://github.com/orbitdb/orbit-db/blob/master/API.md#iteratoroptions) -- [orbitdb.feed(name|address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbfeednameaddress) - - [feed.add(data)](https://github.com/orbitdb/orbit-db/blob/master/API.md#adddata) - - [feed.get(hash)](https://github.com/orbitdb/orbit-db/blob/master/API.md#gethash-1) - - [feed.remove(hash)](https://github.com/orbitdb/orbit-db/blob/master/API.md#removehash) - - [feed.iterator([options])](https://github.com/orbitdb/orbit-db/blob/master/API.md#iteratoroptions-1) -- [orbitdb.docs(name|address, options)](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbdocsnameaddress-options) - - [docs.put(doc)](https://github.com/orbitdb/orbit-db/blob/master/API.md#putdoc) - - [docs.get(hash)](https://github.com/orbitdb/orbit-db/blob/master/API.md#getkey-1) - - [docs.query(mapper)](https://github.com/orbitdb/orbit-db/blob/master/API.md#querymapper) - - [del(key)](https://github.com/orbitdb/orbit-db/blob/master/API.md#delkey) -- [orbitdb.counter(name|address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#orbitdbcounternameaddress) - - [counter.value](https://github.com/orbitdb/orbit-db/blob/master/API.md#value) - - [counter.inc([value])](https://github.com/orbitdb/orbit-db/blob/master/API.md#incvalue) - -**Static Properties** -- [OrbitDB.databaseTypes](https://github.com/orbitdb/orbit-db/blob/master/API.md#databasetypes) - -**Static Methods** -- [OrbitDB.isValidType(type)](https://github.com/orbitdb/orbit-db/blob/master/API.md#isvalidtypetype) -- [OrbitDB.addDatabaseType(type, store)](https://github.com/orbitdb/orbit-db/blob/master/API.md#adddatabasetypetype-store) -- [OrbitDB.getDatabaseTypes()](https://github.com/orbitdb/orbit-db/blob/master/API.md#getdatabasetypes) -- [OrbitDB.isValidAddress(address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#isvalidaddressaddress) -- [OrbitDB.parseAddress(address)](https://github.com/orbitdb/orbit-db/blob/master/API.md#parseaddressaddress) - -**[Store API](https://github.com/orbitdb/orbit-db/blob/master/API.md#store)** -- [load()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeloadamount) -- [close()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeclose) -- [drop()](https://github.com/orbitdb/orbit-db/blob/master/API.md#storedrop) -- [key](https://github.com/orbitdb/orbit-db/blob/master/API.md#storekey) -- [type](https://github.com/orbitdb/orbit-db/blob/master/API.md#storetype) - -**[Store Events](https://github.com/orbitdb/orbit-db/blob/master/API.md#storeevents)** -- [replicated](https://github.com/orbitdb/orbit-db/blob/master/API.md#replicated) -- [replicate](https://github.com/orbitdb/orbit-db/blob/master/API.md#replicate) -- [replicate.progress](https://github.com/orbitdb/orbit-db/blob/master/API.md#replicateprogress) -- [load](https://github.com/orbitdb/orbit-db/blob/master/API.md#load-1) -- [load.progress](https://github.com/orbitdb/orbit-db/blob/master/API.md#loadprogress) -- [ready](https://github.com/orbitdb/orbit-db/blob/master/API.md#ready) -- [write](https://github.com/orbitdb/orbit-db/blob/master/API.md#write) - ### Custom Store Types You can add custom store types to OrbitDB: