S.O.N.G/touhouwiki-mirror
S.O.N.G/touhouwiki-mirror
3
0
Fork 0
Code Issues Pull requests Releases Activity

Update README

Browse source
This commit is contained in:
DataHoarder 2022-02-19 03:12:06 +01:00
parent ff0f1e4758
commit af393f33cc
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -7,6 +7,16 @@ Also includes data fetched under [data/](data/).
# Usage
* `$ ./all.sh` to do a full run updating where necessary
* `$ ./mirror.sh "<category name>" 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