Refresh project documentation

This commit is contained in:
Dymas
2026-08-14 12:27:08 +02:00
parent 89f20235ac
commit 972703d3f9
3 changed files with 34 additions and 4 deletions
+7
View File
@@ -0,0 +1,7 @@
- Always bump `VERSION` unless the only changed files are `Dockerfile`, `*.md`, or `VERSION` itself.
- Always document code and behavior changes in `CHANGELOG.md` unless the only changed files are `Dockerfile`, `*.md`, or `VERSION` itself.
- Update `README.md` whenever user-facing behavior, setup, runtime requirements, Docker usage, or provider state changes.
- Commit changes with a clear commit message and push them after verification.
- Preserve data from existing Kaizoku instances. Updates must not wipe `.kaizoku/` state, configuration, queue history, watchlists, thumbnails, downloads, or Jellyfin library content.
- When needed, install project tools with `pip` or the platform package manager.
- LAN URLs and `github.com` URLs may be accessed when needed for this project.