diff --git a/README.md b/README.md index 122d2b4..f9cc7c0 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,22 @@ about a millisecond; the only per-query network cost is one embedding call. ## Install +```sh +dsh plugin --profile web add git+https://git.notexpectedyet.com/Not-Expected-Yet/dsh-recall.git +``` + +That form installs whatever the default branch holds, pinned to a commit in the +profile's lockfile. The semver fragment installs the newest release tag instead, +and is what makes `dsh plugin update` follow releases — see +[Releases](#releases) for the tag and versioning rules: + +```sh +dsh plugin --profile web add 'git+https://git.notexpectedyet.com/Not-Expected-Yet/dsh-recall.git#semver:^0.1.0' +``` + +To run your own copy instead, add the directory — that becomes a `link:` +dependency which tracks the working tree, so an edit needs no reinstall: + ```sh dsh plugin --profile web add /path/to/dsh-recall ```