aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndrew Lee <andrew@alee14.me>2024-12-24 13:56:06 -0500
committerAndrew Lee <andrew@alee14.me>2024-12-24 13:56:06 -0500
commit4811a3eabc1e7afaf17b45f9dea541d987c45717 (patch)
tree7368782062805aa60dcbeeb3377c35076658decc /README.md
downloadfreeso-discord-auth-4811a3eabc1e7afaf17b45f9dea541d987c45717.tar.gz
freeso-discord-auth-4811a3eabc1e7afaf17b45f9dea541d987c45717.tar.bz2
freeso-discord-auth-4811a3eabc1e7afaf17b45f9dea541d987c45717.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..386f684
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# bnbso-auth
+Web authentication for bnbSO (registering accounts, resetting passwords, changing passwords) using Discord authentication. Programmed for FreeSO-based servers.
+
+To install dependencies:
+
+```bash
+bun install
+```
+
+To run:
+
+```bash
+bun run index.ts
+```
+
+This project was created using `bun init` in bun v1.1.38. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.