diff --git a/README.md b/README.md index 5f7840e..d2452ed 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ # churn + +## Installation + +To install churn, you need first of all a server and agents. + +Servers can be run via. docker. + +```shell +docker run docker.io/kjuulh/churn-v2:latest +``` + +To install an agent run the following script + +```shell +curl https://git.front.kjuulh.io/kjuulh/churn-v2/raw/branch/main/install.sh | bash +``` + +configure `~/.local/share/io.kjuulh.churn-agent/churn-agent.toml` use an editor of choice. Churn agent will generate a randomish name for the specific agent, consider giving it something more semantically meaningful to you