docs: fix README accuracy and improve newcomer experience#61
Merged
Conversation
- docker-compose.example.yaml: add command: watch --once, uncomment WATCH_INTERVAL=12h, add FAVORITES_SYNC_ENABLED comment — fixes silent restart-loop that hammered APIs on docker-compose up -d - README: replace TODO section (falsely marked favorites as unimplemented) with Roadmap (only rewatching remains) - README: add 'What gets synced' table (status, score, progress, dates, favorites) with conflict rule and link to docs/date-sync.md - README: clarify Step 4 dry-run warning and watch daemon explanation - README: fix --once description (first sync waits full interval without it) - config.example.yaml: remove false Patreon NOTE from hato_api section - config.example.yaml: add missing favorites: block - main.go + cli.go: inject version via -ldflags instead of hardcoded 1.0.0 - Makefile: add VERSION and LDFLAGS, pass to go build - Dockerfile: accept VERSION build arg and pass to -ldflags
- Add Prerequisites section (Docker/Go 1.25+ requirements) - Fix Quick Start Step 2: add missing 'cp docker-compose.example.yaml docker-compose.yaml' - Expand Step 3 OAuth flow: explain URL copy, browser redirect, token persistence - Remove --service-ports from dry-run command (only needed for login) - Add 'docker-compose logs -f sync' after daemon start - Move --config to Global options (works for all commands, not just sync) - Replace 'login all' with 'login' everywhere (positional arg was misleading) - Mark WATCH_INTERVAL as required for watch mode - Add full local build section (Option A: go install, Option B: clone + build) - Add docker compose v1/v2 compatibility note - Document reverse-direction strategy chains (Anime + Manga) - Fix docker-compose.example.yaml usage comments - Fix Dockerfile: replace placeholder 'username' with 'bigspawn' in image label - Fix CLAUDE.md: correct build command (./cmd/main.go -> .), remove nonexistent dependencies (jikanGo, cenkalti/backoff) and document actual implementations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Audit and fix of README.md, docker-compose.example.yaml, Dockerfile and CLAUDE.md based on deep comparison against actual code.
Changes
Critical fixes (blocked newcomers from running the project)
cp docker-compose.example.yaml docker-compose.yamlstep; without it Step 3 fails with "no configuration file provided"--service-portsfrom dry-run — only needed forlogin(OAuth callback), not for syncUX / clarity fixes
docker-compose logs -f syncafter daemon start — no way to verify it worked before--configto Global options — it works for all commands (login/logout/status/unmapped) but was only documented under Synclogin allwithlogineverywhere —allwas an ignored positional arg, misleading UXWATCH_INTERVALas required for watch mode — listed as Optional but watch command errors without itdocker-composeinstalledBug fixes
github.com/username/anilist-mal-sync→github.com/bigspawn/anilist-mal-syncin OCI label./cmd/main.go→., directory doesn't exist); remove nonexistent deps (jikanGo,cenkalti/backoff) — Jikan and retry are custom implementationsTesting
No code changes — documentation only.