Skip to content

docs: align README with actual CLI and config - #69

Closed
dyk1454683243-sudo wants to merge 1 commit into
mtiluk:mainfrom
dyk1454683243-sudo:docs/readme-implementation-status
Closed

dyk1454683243-sudo wants to merge 1 commit into
mtiluk:mainfrom
dyk1454683243-sudo:docs/readme-implementation-status

Conversation

@dyk1454683243-sudo

Copy link
Copy Markdown

Summary

Fixes #63 — bring README.md in line with the current CLI and config.

Changes (README only)

  • Fix install path to github.com/mtiluk/potok/cmd/potok@latest
  • Correct config example (server_url, last_synced_at, remote_id)
  • Mark potok sync as not implemented; drop fake --dest pull example
  • Soften Features / Roadmap so they match root.go (push/pull exist; watch-sync does not)
  • Remove the broken (update) server-setup link

Test plan

  • README install command matches go.mod module path
  • Config JSON example matches internal/client/config.Config
  • Commands table matches internal/client/cli/root.go

@mtiluk mtiluk closed this Sep 18, 2026
Repository owner locked and limited conversation to collaborators Sep 18, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants