From af393f33cc266a10c31ba31c2f2bc65b751af5de Mon Sep 17 00:00:00 2001 From: WeebDataHoarder <57538841+WeebDataHoarder@users.noreply.github.com> Date: Sat, 19 Feb 2022 03:12:06 +0100 Subject: [PATCH] Update README --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 3914c9a35..44b13188c 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,16 @@ Also includes data fetched under [data/](data/). # Usage * `$ ./all.sh` to do a full run updating where necessary * `$ ./mirror.sh "" force` if fetching all pages of a category is necessary. +* `$ go run . -path data/` for running a server. Opens on port 8777. + +# Content server features +* Access the entire content tree by path (ex. `/pages/54742.wiki` or `/pages_by_name/RETRO_FUTURE_GIRLS.wiki`) +* List files in a directory (ex. `/pages/` or `/pageindex/Arrangement_CDs/`) +* Query database by either any album title or album catalog number (ex. `/search?type=title&query=マジコカタストロフィ` or `/search?type=title&query=STAL-1302`) + * Values here are normalized so special characters or uppercase are changed. It deals with Unicode too. +* Bare CDDB emulator for `query` and `read` commands. Used to query by track count + length of album. + * query cmd ex. `/cddb?cmd=cddb+query+730dec08` (no need to provide TOC, but can be provided) + * read cmd ex. `/cddb?cmd=cddb+read+Soundtrack54742+730dec08` # License