Merge pull request #4 from Start9Labs/cleaning

Instructions update and set cache as optional setting

instructions.md

@@ -4,7 +4,21 @@
 - Create a new account or access an existing account by using a nip-07 browser extension. If creating a new account, be sure to securely back up the private key, preferably using Vaultwarden on your Start9 server
 - Select the relays you want to use to browse nostr or use your existing relays from other nostr apps
 
-## Using your local nostr relay (optional)
+## Using Your Local Nostr RS Relay (Optional)
 
-If you have Nostr RS Relay installed you can enable the "Use local relay for caching" option to use it as a cache.
-However it must be set to "Public" mode. otherwise it will only cache your events
+1. **Install Nostr RS Relay**:
+   - If you have Nostr RS Relay installed, you're all set!
+
+2. **Enable the "Use Local Relay for Caching" Option**:
+   - In your settings, enable the option that says "Use local relay for caching."
+   - This allows the relay to act as a cache.
+
+3. **Set the Relay to "Public" Mode**:
+   - Make sure the relay is configured in "Public" mode.
+   - Otherwise, it will only cache your own events.
+
+4. **Adjust the "Messages Per Second Limit"**:
+   - For optimal performance, set the "Messages Per Second Limit" to a value greater than 1000.
+   - NoStrudel writes a maximum of 1000 events per second to the cache.
+
+That's it! Your local relay should now work effectively as a cache. 🚀

scripts/procedures/getConfig.ts

@@ -8,7 +8,7 @@ export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({
     description:
       "If you enable the option, noStrudel will cache Nostr events on your personal Nostr relay, which is fast and makes the cache available to all your logged in clients. If you disable this option, noStrudel will instead cache Nostr events in the browser's storage, which is slower and does not sync across clients.",
     type: "boolean",
-    default: true,
+    default: false,
   },
   "cache-relay": {
     name: "Cache Relay",