Update README with new features from #10
Open
- Dominant language
- Python
- Stars
- 2
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
There are several new things in #10, including but not limited to:
- Scripts and the `run` command.
- Configurable setup script (relatedly).
- Using instance names with all commands.
- The `list` command shows you instance names.
- The `--user` CLI flag.
We should update the docs!
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the README and compare its documented commands and setup instructions with the changes described in issue #10. Update the README to cover scripts and the run command, configurable setup, instance names, list output, and the --user flag; done means these listed features are documented accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100