Update README to match actual implementation status
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 76/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- go
- Domain
- cli, documentation
Research direction
Start with README and compare its install command, configuration example, roadmap, and commands table against the current Go CLI behavior. Check the implemented commands—init, doctor, vault-remove, and remote-list—and verify the current config struct and local vault registration and remote listing status. Done means the README accurately documents only the working behavior and marks unfinished work accordingly.
Written by the indexing model from the issue text.
Description
The README describes the prior state of the tool before the reset last month. Specific things are actively wrong:
- Install command is broken.
- Config file example is wrong as the struct was changed.
- Roadmap checkboxes are false with some things stated as implemented yet not. Nothing has been implemented past local vault registration and remote listing.
- Commands table list things that don't exist yet. Currently implemented:
init,doctor,vault-remove,remote-list.
- Dominant language
- Go
- Stars
- 8
- Forks
- 6
- Avg merge
- 1h 29m
- Merged PRs (30d)
- 20
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from mtiluk/potok
-
Add a LICENSE file Opendocumentation good first issue help wanted
Difficulty 1/5 Under an hour Newbie friendliness 90/100
-
documentation good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
documentation good first issue help wanted
Difficulty 3/5 1-2 days Newbie friendliness 72/100
-
documentation good first issue help wanted
Difficulty 5/5 Over a week Newbie friendliness 35/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
-
enhancement needs triage
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
kind/cleanup
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
kubernetes-sigs/kueue#15947 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sympozium-ai/sympozium#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100