aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFuwn <[email protected]>2024-05-14 07:07:03 +0000
committerFuwn <[email protected]>2024-05-14 07:07:03 +0000
commitc343c9891771142c32d47724437db7b5db00d46b (patch)
tree06b3eaa7d284c1a57615ecaa435daafded0efbeb /README.md
parentci(github): gleam check workflow (diff)
downloadmayu-c343c9891771142c32d47724437db7b5db00d46b.tar.xz
mayu-c343c9891771142c32d47724437db7b5db00d46b.zip
feat(Docker): Docker supportv0.1.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.md b/README.md
index 4310f8c..950f407 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,31 @@
> Moe-Counter Compatible Website Hit Counter
+Mayu is a drop-in replacement for [Moe-Counter](https://github.com/journey-ad/Moe-Counter) designed
+to be lightweight and easy to use.
+
+Mayu is written in [Gleam](https://gleam.run) and uses [SQLite](https://sqlite.org) as its database.
+
## Usage
+### Local
+
```bash
$ git clone [email protected]:Fuwn/mayu.git
$ cd mayu
$ gleam run
```
+### Docker
+
+```shell
+docker run --volume 'mayu:/mayu/data/' -p '80:3000' --rm fuwn/mayu:latest
+```
+
+### Database
+
+Mayu will use SQLite by default and will place the database file, `count.db`, within the `data/` directory of the project's root directory.
+
## Resource Attributions
- [A-SOUL_Official](https://space.bilibili.com/703007996)