M .config.example.json → .config.example.json

@@ -2,5 +2,16 @@ {
 	"discord": {
 		"token": "",
 		"app_id": ""
+	},
+	"mongodb": {
+		"uri": "",
+		"database": ""
+	},
+	"projects": {
+		"short": {
+			"name": "name",
+			"displayName": "Formatted Name",
+			"iconURL": "URL of icon - optional"
+		}
 	}
 }

M .zed/settings.json → .zed/settings.json

@@ -3,13 +3,14 @@ //
 // For a full list of overridable settings, and general information on folder-specific settings,
 // see the documentation: https://zed.dev/docs/configuring-zed#settings-files
 {
-  "formatter": {
-    "language_server": {
-      "name": "biome"
-    }
-  },
-  "code_actions_on_format": {
-    "source.fixAll.biome": true,
-    "source.organizeImports.biome": true
-  }
+	"wrap_guides": [80, 100],
+	"formatter": {
+		"language_server": {
+			"name": "biome"
+		}
+	},
+	"code_actions_on_format": {
+		"source.fixAll.biome": true,
+		"source.organizeImports.biome": true
+	}
 }

M COPYING → COPYING.aglpv3

M README.md → README.md

@@ -1,15 +1,53 @@
-# discord bot template
+# stealth developers
 
-barebones discord bot template. see example command in 
-`src/interactions/commands/ping.ts`
+discord bot for the stealth developers community.
 
-copy `.config.example.json` to `.config.json` and fill in the req'd
-values.
+## development
 
-`bun src/index.ts` to start the bot.
+### requirements
 
-## copying 
+- bun
+  get it here https://bun.sh/
 
-this template is made available under the copyleft gnu
-agplv3. you may find a copy of the license in [`COPYING`](./COPYING)
+- a mongodb database
+  - get it here https://www.mongodb.com/try/download/community
+  - or, host it on a service like https://www.mongodb.com/cloud/atlas
 
+- a discord bot token
+  - create a bot here https://discord.com/developers/applications
+  - add the bot to your server with the `bot` and `applications.commands`
+    scopes
+
+### setup
+
+clone the repo and install any deps:
+```sh
+git clone https://github.com/willow-contrib/stealth-developers.git
+cd stealth-developers
+bun install
+```
+
+configure variables in `.config.json`, copy `.config.example.json` to
+`.config.json` and fill in the values.
+
+### running
+
+run the bot with:
+```sh
+bun run start
+```
+
+### development
+
+if you want to run the bot in development mode, you can use:
+```sh
+bun run dev
+```
+
+this will watch for changes in the code and automatically restart the bot when
+changes are detected, beware of rate limits.
+
+## copying
+
+this project is licensed under the copyleft gnu agplv3.0, you can find the full
+license text in [`COPYING.aglpv3`](./COPYING.agplv3).