doc: add sample settings file

README.md

@@ -116,8 +116,10 @@ You can change the default folder by setting the `NOSTR_CONFIG_DIR` environment
 Run nostr-ts-relay using one of the quick-start guides at least once and `~/.nostr/settings.json` will be created.
 Any changes made to the settings file will be read on the next start.
 
-See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
+A sample settings file is included at the project root under the name `settings.sample.json`. Feel free to copy it to `~/.nostr/settings.json`
+if you would like to have a settings file before running the relay first.
 
+See [CONFIGURATION.md](CONFIGURATION.md) for a detailed explanation of each environment variable and setting.
 ## Dev Channel
 
 For development discussions, please use the [Nostr Typescript Relay Dev Channel](https://t.me/nostr_ts_relay).

settings.sample.json

@@ -0,0 +1,35 @@
+{
+  "info": {
+    "relay_url": "wss://nostr-ts-relay.your-domain.com",
+    "name": "nostr-ts-relay.your-domain.com",
+    "description": "A nostr relay written in Typescript.",
+    "pubkey": "replace-with-your-pubkey",
+    "contact": "[email protected]"
+  },
+  "limits": {
+    "event": {
+      "eventId": {
+        "minLeadingZeroBits": 0
+      },
+      "kind": {
+        "whitelist": [],
+        "blacklist": []
+      },
+      "pubkey": {
+        "minLeadingZeroBits": 0,
+        "whitelist": [],
+        "blacklist": []
+      },
+      "createdAt": {
+        "maxPositiveDelta": 900,
+        "maxNegativeDelta": 0
+      }
+    },
+    "client": {
+      "subscription": {
+        "maxSubscriptions": 10,
+        "maxFilters": 10
+      }
+    }
+  }
+}