commit f9b981d5a486aafa5bfa3c04010446466e2f42ab
parent 3d5b0135f50ead723dc2378f10fc819148579774
Author: Oscar Fu <[email protected]>
Date: Thu, 2 Nov 2023 00:12:41 +0000
Create README.md
Diffstat:
1 file changed, 26 insertions(+), 0 deletions(-)
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# Auth
+
+Auth is a Discord Bot to verify user, giving server owner the ability to pull back members in case of deletetion or forgot login.
+## Getting Started
+
+To get started with the project, simply clone the repository and install the dependencies
+
+```cmd
+git clone https://github.com/night0721/Auth.git
+cd Auth
+npm i
+npm run dev
+```
+
+## Support
+
+If you need support, you can join the [Discord server](https://discord.gg/SbQHChmGcp)
+
+## License
+
+This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information.
+
+## Contribution
+
+If you have any ideas for improvements or new features, please feel free to fork the project and create a pull request or open an issue.
+All contributions are welcome, including translations, documentation, and code.