tool-db 1.4.3 → 2.0.1

package/README.md

@@ -27,6 +27,25 @@ While the database is currently functioning as expected, there are many things t
 - Allow messages encryption, add methods for Elliptic Curves, shared keys, etc.
 - Allow adding Noise/encryption to connections (probably based on the ECC?)
 
+# Install
+
+You can install ToolDb via npm or yarn;
+
+```
+npm install tool-db
+```
+
+or use it via script in your html;
+
+```
+<script src="https://unpkg.com/tool-db/bundle.js"></script>
+```
+
+That will include all of ToolDb exports in `tooldb`, then you can use it like;
+
+```
+const { ToolDb, sha256 } = tooldb;
+```
 
 ## Base usage
 Connect to the selected toolDb peers;
@@ -38,34 +57,34 @@ These are the options you can pass to the constructor:
 
 ```
 {
-  // Database name to use
+  // Database name to use (default "tooldb")
   db: string;
 
-  // Show debug console logs
+  // Show debug console logs (default false)
   debug: boolean;
 
   // Array of peers to connect to, each one in the form of { host: "127.0.0.1", port: 9000 }
   peers: { host: "127.0.0.1", port: 9000 }[];
 
-  // Max number of tries when a connection fails
+  // Max number of tries when a connection fails (default 5)
   maxRetries: number;
 
-  // How long to wait (max) for a debounced key listener recv
+  // How long to wait (max) for a debounced key listener recv (default 100)
   triggerDebouce: number;
 
-  // How long to wait between retries
+  // How long to wait between retries (default 2000)
   wait: number;
 
-  // If you want to force a Proof of Work on all messages, set how much (zero is no POW)
+  // If you want to force a Proof of Work on all messages, set how much (zero is no POW, default 0)
   pow: number;
 
-  // Weter we are a server or not
+  // Whether we are a server or not (default false)
   server: boolean;
 
   // Our hostname (server only)
   host: string
 
-  // Port to listen incoming connections (server only)
+  // Port to listen incoming connections (server only, default is 8080)
   port: number;
 
   // A server instance like Express (server only)
@@ -80,10 +99,10 @@ These are the options you can pass to the constructor:
   // A custom storage adapter function
   storageAdapter: ToolDbStorageAdapter;
 
-  // Our client ID (defaults to a random ID)
+  // Our client ID (defaults to a generated publicKey)
   id: string;
 
-  // The namespace/topic of our app
+  // The namespace/topic of our app (default is "tool-db-default")
   topic: string;
   
   // Public and private (ECDSA) keys of our client. In the default network adapter these are used to sign
@@ -104,9 +123,7 @@ client.anonSignIn().then();
 
 To retrieve your public key; (only if logged in)
 ```
-client.getPubKey().then(pubKey);
-// or
-client.user?.pubKey
+client.getPubKey();
 ```
 
 You can check if you are correctly logged in by checking if the user field exists or not;
@@ -200,7 +217,8 @@ function handleDocumentKeyCrdt(msg) {
 ## Events
 
 If you need to check when you are connected to a server peer or not you can use the following method replacements;
+
 ```
-client.onConnect = () => { /* Your code here */ };
+client.onConnect = (remotePeerId: string) => { /* Your code here */ };
 client.onDisconnect = () => { /* Your code here */ };
 ```