Add rebuild documentation

ssbc · Sep 9, 2022 · 18ce13a · 18ce13a
1 parent 4c8a8b5
commit 18ce13a
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -665,6 +665,13 @@ db.unbox(data, key)
 ```
 Attempt to decrypt data using key. Key is a symmetric key, that is passed to the unboxer objects.
 
+## db.rebuild: async
+```js
+db.rebuild(cb)
+```
+
+Rebuilds the indexes. This takes a while to run and using SSB features before it is completed may lead to confusing experiences as the indexes will be out of sync.
+
 ## db.Deprecated apis
 
 ## db.getLatest: async