diff --git a/README.md b/README.md index 17a5764..6e91ae2 100644 --- a/README.md +++ b/README.md @@ -35,8 +35,17 @@ Implemented commands: - `link [CASTLE]` - `unlink [CASTLE]` - `track FILE [CASTLE]` +- `rc [CASTLE]` - `version` +### rc behavior + +- Runs executable scripts in `/.homesick.d/` in lexicographic order. +- Executes scripts with the castle root as the current working directory. +- Forwards script stdout/stderr to command output. +- If `/.homesickrc` exists and `/.homesick.d/parity.rb` does not, generates `parity.rb` before execution. +- Never overwrites an existing `parity.rb` wrapper. + Not yet implemented: - `pull` @@ -47,9 +56,28 @@ Not yet implemented: - `open` - `exec` - `exec_all` -- `rc` - `generate` +## Outstanding Feature Checklist + +Command parity: + +- [ ] `pull` +- [ ] `push` +- [ ] `commit` +- [ ] `destroy` +- [ ] `cd` +- [ ] `open` +- [ ] `exec` +- [ ] `exec_all` +- [ ] `generate` + +Historical flag/behavior parity: + +- [ ] `pull --all` +- [ ] `rc --force` +- [ ] Evaluate whether global `pretend`/`quiet` modes should be restored + ## Behavior Suite The repository includes a Docker-based behavior suite that validates filesystem and git outcomes for the implemented commands.