diff --git a/README.md b/README.md index 7873004..7f8ce5a 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,21 @@ shell: | cargo test --locked --workspace ``` - [Radicle CI broker]: https://app.radicle.xyz/nodes/radicle.liw.fi/rad:zwTxygwuz5LDGBq255RA2CbNGrz8 +[Radicle CI broker]: https://app.radicle.xyz/nodes/radicle.liw.fi/rad:zwTxygwuz5LDGBq255RA2CbNGrz8 +This crate also includes the program `rad-ci`, which runs the commands +the adapter runs when invoked by the CI broker. To use: install it on +your `$PATH` (using `cargo install`) and run: + +```sh +rad ci +``` + +This will read `.radicle/native.yaml` and run the shell commands +specified there. + +(No command line arguments or options needed, nor any environment +variables for this.) ## Architecture