Merge branch 'dev'

sakkke · Mar 24, 2024 · 70fafbb · 70fafbb
2 parents 0d41c10 + 6aa3ab2
commit 70fafbb
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,19 @@
-# mc-express
+# mc-express
+
+## Description
+
+`mc-express` is a proxy service that maps /maps and /Backups under Discord authentication.
+The motivation for this project is adding Discord authentication to services that do not have authentication functionality.
+
+## Usage
+
+```
+git clone https://github.com/sakkke/mc-express.git
+cd mc-express
+bun install
+bun run ./src/server.js
+```
+
+## License
+
+[MIT](./LICENSE)