Skip to content

Commit b6e4167

Browse files
committed
Update README.md
1 parent cf4d573 commit b6e4167

1 file changed

Lines changed: 5 additions & 18 deletions

File tree

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# wuwa-api
22

3-
A Node.js (Fastify) REST API + importer for **Wuthering Waves** data. It serves structured JSON (characters, weapons, metadata) and local images.
3+
A Node.js (Fastify) REST API for **Wuthering Waves** data. It serves structured JSON (characters, weapons, metadata) and local images.
4+
5+
Data generation/import is maintained privately; this repo ships only the API + the published dataset under `assets/`.
46

57
Not affiliated with or endorsed by Kuro Games.
68

@@ -11,7 +13,7 @@ Not affiliated with or endorsed by Kuro Games.
1113
- File-backed dataset:
1214
- `assets/data/**/en.json`
1315
- `assets/images/**` (normalized `.webp`)
14-
- Importer that pulls from community sources (Prydwen + Fandom) and normalizes:
16+
- Published dataset under `assets/` (generated privately from community sources and normalized):
1517
- character skills + scaling tables
1618
- character base stats at levels `20/50/90`
1719
- character images: `icon/card/splash/attribute`
@@ -152,20 +154,9 @@ Rate limiting is enforced by `@fastify/rate-limit` using **route-level tiers**.
152154

153155
This API is designed to be public but discourage heavy usage (encourage self-hosting).
154156

155-
## Importer (private)
156-
157-
This repository intentionally does **not** include the importer/scraper.
158-
159-
Reason: publishing scraping code in a public repository can cause unwanted load on upstream community sites.
160-
161-
If you are the maintainer and want the importer:
162-
- keep it in a **private** repo
163-
- run it locally to generate `assets/data` and `assets/images`
164-
- then publish only the dataset you’re comfortable making public (or keep the repo private)
165-
166157
## Validate data
167158

168-
After importing (or after manual edits):
159+
After updating `assets/` (or after manual edits):
169160

170161
```bash
171162
npm run validate-data
@@ -188,10 +179,6 @@ The demo HTML is loaded from `.local/demo` (gitignored) so it won’t be publish
188179

189180
The dataset in `assets/` is sourced from community resources (e.g. Prydwen and Fandom).
190181

191-
If you maintain your own private importer, be respectful:
192-
- avoid tight loops
193-
- keep delays reasonable
194-
- comply with site rules/ToS
195182

196183
## Docker + deployment notes
197184

0 commit comments

Comments
 (0)