From e756d03374c130bf56bc0626557ce914f503ba0b Mon Sep 17 00:00:00 2001
From: status-im-auto <auto@status.im>
Date: Tue, 17 Jan 2023 10:45:31 +0000
Subject: [PATCH] Updates

---
 light-js/README.md | 13 +++++++++++++
 relay-js/README.md | 13 +++++++++++++
 rln-js/README.md   | 30 ++++++++++++++++++++++++++++++
 store-js/README.md | 13 +++++++++++++
 4 files changed, 69 insertions(+)
 create mode 100644 light-js/README.md
 create mode 100644 relay-js/README.md
 create mode 100644 rln-js/README.md
 create mode 100644 store-js/README.md

diff --git a/light-js/README.md b/light-js/README.md
new file mode 100644
index 0000000..ebc032a
--- /dev/null
+++ b/light-js/README.md
@@ -0,0 +1,13 @@
+# Using Waku Light Push and Filter in JavaScript
+
+**Demonstrates**:
+
+- Waku Light node: Waku Filter + Waku Light Push
+- Pure Javascript/HTML.
+- Use minified bundle of js from unpkg.com, no import, no package manager.
+
+This example uses Waku Filter to listen to messages and Waku Light Push to send messages.
+
+To test the example, simply download the `index.html` file from this folder and open it in a browser.
+
+The `master` branch's HEAD is deployed at https://examples.waku.org/light-js/.
diff --git a/relay-js/README.md b/relay-js/README.md
new file mode 100644
index 0000000..657aa7b
--- /dev/null
+++ b/relay-js/README.md
@@ -0,0 +1,13 @@
+# Using Waku Relay in JavaScript
+
+**Demonstrates**:
+
+- Waku Relay: Send and receive messages using Waku Relay.
+- Pure Javascript/HTML.
+- Use minified bundle of js from unpkg.com, no import, no package manager.
+
+This example uses Waku Relay to send and receive simple text messages.
+
+To test the example, simply download the `index.html` file from this folder and open it in a browser.
+
+The `master` branch's HEAD is deployed at https://examples.waku.org/relay-js/.
diff --git a/rln-js/README.md b/rln-js/README.md
new file mode 100644
index 0000000..e6dc62e
--- /dev/null
+++ b/rln-js/README.md
@@ -0,0 +1,30 @@
+# Using [RLN](https://rfc.vac.dev/spec/32/) in JavaScript
+
+> Rate limiting nullifier (RLN) is a construct based on zero-knowledge proofs
+> that provides an anonymous rate-limited signaling/messaging framework
+> suitable for decentralized (and centralized) environments
+
+**Demonstrates**:
+
+- RLN:
+  - Generate credentials
+  - Insert membership to smart contract (Goerli testnet)
+  - Retrieve smart contract state
+  - Generate and send proofs
+  - Verify incoming proofs
+- Pure Javascript/HTML.
+- Use minified bundle of js from unpkg.com, no import, no package manager.
+
+To test the example:
+
+```shell
+git clone https://github.com/waku-org/js-waku-examples
+cd js-waku-examples/rln-js
+npm install
+npm run start
+# open  http://127.0.0.1:8080 In your browser
+```
+
+**There are a known issue using this webapp with Firefox + MetaMask. Try Chrome or Brave if you encounter any issue**.
+
+The `master` branch's HEAD is deployed at https://examples.waku.org/rln-js/.
diff --git a/store-js/README.md b/store-js/README.md
new file mode 100644
index 0000000..a4bc37b
--- /dev/null
+++ b/store-js/README.md
@@ -0,0 +1,13 @@
+# Using Waku Store in JavaScript
+
+**Demonstrates**:
+
+- Waku Store: Using a condition to stop retrieving results from Waku Store.
+- Pure Javascript/HTML.
+- Use minified bundle of js from unpkg.com, no import, no package manager.
+
+This example uses Waku Store to retrieve the latest ping relay message (used for keep alive purposes) and displays its timestamp.
+
+To test the example, simply download the `index.html` file from this folder and open it in a browser.
+
+The `master` branch's HEAD is deployed at https://examples.waku.org/store-js/.