readme

Suwayomi · Nov 26, 2023 · 8a0e1db · 8a0e1db
1 parent b635825
commit 8a0e1db
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,27 @@
 # vui-tracking
 
+A backed server that exists solely for VUI to have access to the MangaUpdates api
+
+# How To Use:
+
+## Docker
+
+```yml
+version: "3.7"
+services:
+  tachidesk-vui-tracking:
+    image: ghcr.io/suwayomi/tachidesk-vui-tracking
+    ports:
+      - "9014:3000"
+    restart: unless-stopped
+```
+
+## Other
+
+you can run it natively like a developer would (see below) though you wont get help if something goes wrong
+
+## Development
+
 To install dependencies:
 
 ```bash
@@ -9,7 +31,7 @@ bun install
 To run:
 
 ```bash
-bun run index.ts
+bun start
 ```
 
 This project was created using `bun init` in bun v1.0.12. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
diff --git a/docker-compose-example.yml b/docker-compose-example.yml
@@ -1,6 +1,6 @@
 version: '3.7'
 services:
-  vui3:
+  tachidesk-vui-tracking:
     image: ghcr.io/suwayomi/tachidesk-vui-tracking
     ports:
       - '9014:3000'