Skip to content

docs: align README with current CLI - #55

Closed
team-humaki wants to merge 2 commits into
mtiluk:mainfrom
team-humaki:docs/readme-match-impl-48
Closed

team-humaki wants to merge 2 commits into
mtiluk:mainfrom
team-humaki:docs/readme-match-impl-48

Conversation

@team-humaki

Copy link
Copy Markdown

Fixes #48.

README was describing the pre-reset tooling. This updates install (cmd/potok), config (server_url / last_synced_at), the commands table (status for push/pull/sync), usage examples, and roadmap checkboxes so they match what's actually wired in root.go today.

Fix install path, config example, commands, and roadmap for #48.
@mtiluk
mtiluk self-requested a review September 12, 2026 16:39

@mtiluk mtiluk left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, thanks for the PR. There's a few things that need changing before this can be merged.

  1. The install command still point at github.com/michaeltukdev/Potok - this should be mtiluk. The go.mod's module path is still michaeltukdev too, so a full fix means updating that plus every import across the repo. Might be worth a separate PR rather than doing it all here?
  2. The config.json example shows remote_id and last_synced_at but both fields are omitempty in the Vault struct. Add another fresh vault example to the list without them and keep the one with them.

Thank you for this again.
P.s. star the repo :)

@team-humaki

Copy link
Copy Markdown
Author

Addressed the review:

  • Both go install lines now use github.com/mtiluk/potok/... (correct casing for this repo).
  • Config examples: one fresh vault without remote_id/last_synced_at (omitempty), plus the existing synced vault with those fields.
  • Left the go.mod module rename for a follow-up PR, as suggested.

@mtiluk
mtiluk self-requested a review September 13, 2026 02:31

@mtiluk mtiluk left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rebase onto main and then this can be approved. :)

I went ahead and made the go.mod module renams to enure this works - thank you.

@mtiluk mtiluk closed this Sep 14, 2026
Repository owner locked as spam and limited conversation to collaborators Sep 14, 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