init

1 files changed, 26 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..36bed50
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,26 @@
+# SNS Chan
+Official Custom Discord Bot for Supernoobs Discord Server
+
+
+## running
+---
+made for linux or unix systems, running elsewhere isnt supported but should probably work:3
+(for windows you can probably use msys or git bash)
+
+- `npm i`
+- put tokens and api keys in .env-example, and move it to .env
+- `sh buildconfig.sh`
+- `node .` or `sh snschan.sh` (to restart on error)
+
+
+## todo ~
+---
+- [x] settings for each command
+- [x] restricted channels
+- [x] restrict to a channel
+- [x] cooldown
+- [ ] test commands
+- [ ] reset/refresh command
+- [ ] settings webui
+- [ ] settings via discord commands
+- [ ] slash commands