From 70535d85f09afdb7885a054ac26311997bbcf56a Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <liw@liw.fi>
Date: Fri, 22 Nov 2024 09:05:12 +0200
Subject: [PATCH] doc: add rad-ci to README

Signed-off-by: Lars Wirzenius <liw@liw.fi>
---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

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