Skip to content

Comments

docs: fix README.md to match actual code and config#52

Merged
bigspawn merged 2 commits intomainfrom
docs/fix-readme-errors
Feb 16, 2026
Merged

docs: fix README.md to match actual code and config#52
bigspawn merged 2 commits intomainfrom
docs/fix-readme-errors

Conversation

@bigspawn
Copy link
Owner

Summary

  • Fix docker-compose example in README to match docker-compose.example.yaml (comment out optional settings, add missing vars)
  • Fix ID mapping strategy chains: remove Jikan from anime, add Jikan to manga (matches app.go)
  • Add missing http_timeout and hato_api.cache_max_age to config example
  • Document fallback env vars (CLIENT_SECRET_ANILIST, CLIENT_SECRET_MYANIMELIST)
  • Add note about MALID strategy in reverse sync mode
  • Remove deprecated version: "3" from docker-compose.example.yaml

Test plan

  • Visually verified README docker-compose block matches docker-compose.example.yaml
  • Visually verified README config example matches config.example.yaml
  • Verified strategy chains against app.go:114-183
  • Verified fallback env vars against config.go:207,213
  • All tests pass (pre-push hook)

- Fix docker-compose example to match docker-compose.example.yaml
  (comment out optional ID mapping settings, add Jikan/WATCH_INTERVAL/MAPPINGS_FILE_PATH)
- Remove version: "3" from docker-compose example
- Fix ID mapping strategy chains: remove Jikan from anime, add Jikan to manga
- Add note about MALID strategy in reverse sync mode
- Add missing http_timeout and hato_api.cache_max_age to config example
- Document fallback env vars (CLIENT_SECRET_ANILIST, CLIENT_SECRET_MYANIMELIST)
The top-level "version" property is deprecated in modern Docker Compose
and no longer has any effect.
@bigspawn bigspawn merged commit 2fc34c9 into main Feb 16, 2026
3 checks passed
@bigspawn bigspawn deleted the docs/fix-readme-errors branch February 16, 2026 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant