@waku/rln 0.1.1 → 0.1.2-126bce3

package/README.md

@@ -51,7 +51,11 @@ Or to use ESM import directly from a `<script>` tag:
 ```
 git clone https://github.com/waku-org/js-rln
 
-cd js-rln/example
+cd js-rln/
+
+npm install
+
+cd example/
 
 npm install  # or yarn
 
@@ -67,7 +71,16 @@ Browse http://localhost:8080 and open the dev tools console to see the proof bei
 ```js
 import * as rln from "@waku/rln";
 
-const rlnInstance = await rln.create();
+const rlnInstance = await rln.createRLN();
+```
+
+### Starting RLN to listen to a contract
+
+```js
+import * as rln from "@waku/rln";
+
+const rlnInstance = await rln.createRLN();
+await rlnInstance.start(); // will use default Sepolia contract
 ```
 
 #### Generating RLN Membership Credentials
@@ -90,6 +103,17 @@ let credentials = rlnInstance.generateSeededIdentityCredentials(seed);
 rlnInstance.insertMember(credentials.IDCommitment);
 ```
 
+### Registering Membership on a contract
+
+```js
+import * as rln from "@waku/rln";
+
+const rlnInstance = await rln.createRLN();
+await rlnInstance.start(); // will use default Sepolia contract
+
+const membershipInfo = await rlnInstance.contract.registerWithKey(credentials);
+```
+
 ### Generating a Proof
 
 ```js