From 6907e361214b4cb6261fb01598c26cf2411ed822 Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <liw@liw.fi>
Date: Fri, 8 Dec 2023 14:24:46 +0200
Subject: [PATCH] docs: add a README.md

Signed-off-by: Lars Wirzenius <liw@liw.fi>
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ca0491e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# radicle-native-ci
+
+This is an adapter for Radicle CI, for performing CI runs locally.
+It's meant to be used with, and executed by, `radicle-c-broker`.
+
+The CI run is performed locally, without any isolation. This is not
+safe and secure, but it's simple, and easy to get working. Do not use
+this unless you trust the repository.
+
+The repository must contain a file `.ci/radicle.yaml` that
+specifies how CI is run for the repository. For example:
+
+```yaml
+shell: |
+  cargo test --locked --workspace
+```