docs(README.md): note env vars, logging

Signed-off-by: Lars Wirzenius <liw@liw.fi>
2026-10-18 19:10:37 +08:00 · 2024-04-15 19:30:22 +03:00
parent 8d90bd1459
commit cae775ca67
1 changed files with 4 additions and 1 deletions
@@ -1,7 +1,10 @@
 # radicle-native-ci

 This is an adapter for the [Radicle CI broker], for performing CI runs
-locally.
+locally. This means it reads a JSON message from its stdin, and writes
+two JSON messages to its stdout. Its configured via a configuration
+file specified in the `RADICLE_NATIVE_CI` environment variable. There
+is currently no logging.

 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