docs: update & fix README

Author: mistakia

README.md

@@ -17,12 +17,42 @@ Base class for [orbit-db](https://github.com/orbitdb/orbit-db) data stores. You
 
 ### API
 
+#### constructor(ipfs, peerId, address, options)
+
+```javascript
+//TODO
+const store = new Store(ipfs, peerId, address, options)
+```
+
+`options` is an object with any of the following properties
+
+- `Index` ():
+- `maxHistory` (Integer):
+- `path` (String):
+- `replicate` (Boolean):
+- `referenceCount` (Integer):
+- `replicationConcurrency` (Integer):
+- `cache` ():
+- `keystore` ():
+- `key` ():
+- `accessController` ():
+- `onClose` (Function):
+
 #### Public methods
 
 ##### `load(amount)`
 
 Load the database using locally persisted state. Can specify how many entries to load with `amount` argument.
 
+##### `loadMoreFrom(amount, entries)`
+
+TODO
+
+```javascript
+//TODO
+db.loadMoreFrom()
+```
+
 ##### `saveSnapshot()`
 
 Save the current state of the database locally. Returns a *Promise* that resolves to a IPFS Multihash as a Base58 encoded string. The the database can be loaded using this hash.
@@ -63,6 +93,14 @@ console.log(db.key.toPublic('hex'))
 // 042c07044e7ea51a489c02854db5e09f0191690dc59db0afd95328c9db614a2976e088cab7c86d7e48183191258fc59dc699653508ce25bf0369d67f33d5d77839
 ```
 
+##### `all`
+
+Returns an array of all store entries.
+
+```javascript
+db.all
+```
+
 ##### `type`
 
 Remove all items from the local store. This doesn't remove or delete any entries in the distributed operations log.
@@ -84,49 +122,72 @@ console.log(db.replicationStatus)
 
   Store has an `events` ([EventEmitter](https://nodejs.org/api/events.html)) object that emits events that describe what's happening in the database.
 
-  - `load` - (dbname, hash)
+  - `load` - (address, heads)
 
-    Emitted before loading the database history. *hash* is the hash from which the history is loaded from.
+    Emitted before loading the database history. *address* is a string of the OrbitDB address that emitted the event. *heads* is an array of ipfs-log Entries.
 
     ```javascript
-    db.events.on('load', (id, hash) => ... )
+    db.events.on('load', (address, heads) => ... )
     db.load()
     ```
 
-  - `ready` - (dbname)
+  - `ready` - (address, heads)
 
-    Emitted after fully loading the database history.
+    Emitted after fully loading the database history. *address* is a string of the OrbitDB address that emitted the event. *heads* is an array of ipfs-log Entries.
 
     ```javascript
-    db.events.on('ready', (id) => ... )
+    db.events.on('ready', (address, heads) => ... )
     db.load()
     ```
 
-  - `load.progress` - (id, hash, entry, progress, total)
+  - `load.progress` - (address, hash, entry, progress, total)
 
-    Emitted for each entry during load.
-
-    *Progress* is the current load count. *Total* is the maximum load count (ie. length of the full database). These are useful eg. for displaying a load progress percentage.
+    Emitted for each entry during load. *address* is a string of the OrbitDB address that emitted the event. *hash* is the multihash of the entry that was just loaded. *entry* is the ipfs-log Entry that was loaded. *Progress* is the current load count. *Total* is the maximum load count (ie. length of the full database). These are useful eg. for displaying a load progress percentage.
 
     ```javascript
-    db.events.on('load', (id, hash, entry, progress, total) => ... )
+    db.events.on('load.progress', (address, hash, entry, progress, total) => ... )
     db.load()
     ```
 
-  - `replicated` - (dbname)
+  - `replicate` - (address, entry)
+
+    Emitted before replicating a part of the database. *address* is a string of the OrbitDB address that emitted the event. *entry* is the ipfs-log Entry that is being processed.
+
+    ```javascript
+    db.events.on('replicate', (address, entry) => ... )
+    ```
+
+  - `replicate.progress` - (address, hash, entry, progress, total)
+
+    Emitted while replicating a database. *address* is a string of the OrbitDB address of the database that emitted the event. *hash* is the multihash of the entry that was just replicated. *entry* is the ipfs-log Entry that was replicated. *progress* is an integer representing the current progress. *total* is an integer representing the remaining operations.
+
+    ```javascript
+    db.events.on('replicate.progress', (address, hash, entry, progress, total) => ... )
+    ```
+
+  - `replicated` - (address, logCount)
+
+    Emitted after the database was synced with an update from a peer database. *address* is a string of the OrbitDB address that emitted the event. *logCount* ...
+
+    ```javascript
+    db.events.on('replicated', (address, logCount) => ... )
+    ```
+
+  - `write` - (address, entry, heads)
 
-    Emitted after the database was synced with an update from a peer database.
+    Emitted after an entry was added locally to the database. *address* is a string of the OrbitDB address that emitted the event. *entry* is the Entry that was added. *heads* is an array of ipfs-log Entries.
 
     ```javascript
-    db.events.on('replicated', (id) => ... )
+    db.events.on('write', (address, entry, heads) => ... )
     ```
 
-  - `write` - (id, hash, entry)
+  - `closed` - (address)
 
-    Emitted after an entry was added locally to the database. *hash* is the IPFS hash of the latest state of the database. *entry* is the Entry that was added.
+    Emitted once the database has finished closing. *address* is a string of the OrbitDB address that emitted the event.
 
     ```javascript
-    db.events.on('write', (id, hash, entry) => ... )
+    db.events.on('closed', (address) => ... )
+    db.close()
     ```
 
 #### Private methods
@@ -153,9 +214,9 @@ const Store         = require('orbit-db-store');
 const KeyValueIndex = require('./KeyValueIndex');
 
 class KeyValueStore extends Store {
-  constructor(ipfs, id, dbname, options) {
+  constructor(ipfs, peerId, address, options) {
     Object.assign(options || {}, { Index: KeyValueIndex });
-    super(ipfs, id, dbname, options)
+    super(ipfs, peerId, address, options)
   }
 
   get(key) {

src/Store.js

@@ -310,7 +310,7 @@ class Store {
   }
 
   async loadFromSnapshot (onProgressCallback) {
-    this.events.emit('load', this.address.toString())
+    this.events.emit('load', this.address.toString()) //TODO: inconsistent params, line 207
 
     const maxClock = (res, val) => Math.max(res, val.clock.time)
 
@@ -400,7 +400,7 @@ class Store {
         const log = await Log.fromJSON(this._ipfs, snapshotData, -1, this._key, this.access.write, 1000, onProgress)
         await this._oplog.join(log)
         await this._updateIndex()
-        this.events.emit('replicated', this.address.toString())
+        this.events.emit('replicated', this.address.toString()) //TODO: inconsistent params, line 116
       }
       this.events.emit('ready', this.address.toString(), this._oplog.heads)
     } else {