aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bc2517b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# feedaka
+
+A simple RSS/Atom feed reader. This is my personal project and is developed for my use only.
+
+## Requirements
+
+* Go 1.24+
+* Node.js 22+
+* Docker and Docker Compose
+* [Just](https://github.com/casey/just)
+
+## Run
+
+### Docker
+
+```bash
+$ docker compose up
+```
+
+Access at <http://localhost:8002>.
+
+### Non-docker
+
+```bash
+$ just build
+$ cd frontend && npm run dev &
+$ cd .. && just serve
+``` \ No newline at end of file