From cae775ca6778f08917b87a8e03b5b053ea9694d6 Mon Sep 17 00:00:00 2001 From: Lars Wirzenius Date: Mon, 15 Apr 2024 19:30:22 +0300 Subject: [PATCH] docs(README.md): note env vars, logging Signed-off-by: Lars Wirzenius --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 43ca7b0..7873004 100644 --- a/README.md +++ b/README.md @@ -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