Initial commit

readme.md

@@ -0,0 +1,30 @@
+# shanty-web
+
+Web interface backend for [Shanty](ssh://connor@git.rcjohnstone.com:2222/Shanty/shanty.git).
+
+Actix-web server exposing a REST API that ties together all Shanty components.
+Serves the Elm frontend and orchestrates indexing, tagging, downloading, and organization.
+
+## Usage
+
+```sh
+shanty-web                          # start with default config
+shanty-web --config /path/to/config.yaml
+shanty-web --port 9090              # override port
+```
+
+## Configuration
+
+Create `~/.config/shanty/config.yaml`:
+
+```yaml
+library_path: ~/Music
+download_path: ~/.local/share/shanty/downloads
+web:
+  port: 8085
+  bind: 0.0.0.0
+```
+
+## API
+
+All endpoints under `/api/`. See the issue tracker for full API documentation.