Initial implementation: scrape, serve, UI, container, deploymentHEADmain

1 files changed, 27 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b17fdb3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# abvjt
+
+Journal abbreviation lookup. Scrapes [Web of Science](https://wos-help.webofscience.com/WOKRS535R111/help/WOS/0-9_abrvjt.html) journal title abbreviation pages, stores them in SQLite with FTS5, serves a search UI and a JSON API.
+
+Abbreviation data sourced from Web of Science (Clarivate).
+
+## Usage
+
+```
+go build -o abvjt .
+./abvjt scrape                    # fetch WOS pages, build DB
+./abvjt serve                      # start server on :8080
+./abvjt serve --port 3000 --db data/abvjt.db
+```
+
+| Command | Description |
+|---------|-------------|
+| `scrape` | Fetch WOS abbreviation pages, parse HTML, write SQLite |
+| `serve`  | HTTP server (web UI + JSON API) |
+| `help`   | Usage info |
+
+## API
+
+```
+GET /api/search?q=nature&limit=50
+GET /api/health
+```