aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-05-13 23:37:52 -0700
committerFuwn <[email protected]>2024-05-13 23:37:52 -0700
commit1d33aa6cc84d68358a537041628b179f572083ec (patch)
treefc3dec26c9280af36357100e33a30bf29998b908 /README.md
downloadmayu-1d33aa6cc84d68358a537041628b179f572083ec.tar.xz
mayu-1d33aa6cc84d68358a537041628b179f572083ec.zip
feat: initial release
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..4310f8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# ⭐ Mayu
+
+> Moe-Counter Compatible Website Hit Counter
+
+## Usage
+
+```bash
+$ git clone [email protected]:Fuwn/mayu.git
+$ cd mayu
+$ gleam run
+```
+
+## Resource Attributions
+
+- [A-SOUL_Official](https://space.bilibili.com/703007996)
+- [Moebooru](https://github.com/moebooru/moebooru)
+- [Rule 34](https://rule34.xxx) (NSFW)
+- [Gelbooru](https://gelbooru.com) (NSFW)
+
+## Licence
+
+This project is licensed with the [GNU General Public License v3.0](LICENSE).