From 03c4c4e1164e18306652ed5d18f7e9dcfb3b139a Mon Sep 17 00:00:00 2001
From: Jason Song <i@wolfogre.com>
Date: Thu, 24 Nov 2022 16:34:29 +0800
Subject: [PATCH] docs: add quickstart to readme

---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 40 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 0b91152..023f4eb 100644
--- a/README.md
+++ b/README.md
@@ -2,14 +2,46 @@
 
 Act runner is a runner for Forges supports Github Actions protocol.
 
-## Rigister
+## Quickstart
 
-create a new file as name `.env`
+### build
 
-```sh
-GITEA_RUNNER_NAME=
-GITEA_RPC_PROTO=http
-GITEA_RPC_HOST=localhost:3001
-GITEA_RUNNER_TOKEN=1234567890abcde
-GITEA_RUNNER_LABELS=foo,bar
+```shell
+make build
 ```
+
+### register
+
+```shell
+./act_runner register
+```
+
+And you will be asked to input:
+
+1. Gitea instance URL, like `http://localhost:3000/`;
+2. Runner token, you can get it from `http://localhost:3000/admin/runners`;
+3. Runner name, you can just leave it blank;
+4. Runner labels, you can just leave it blank.
+
+The process looks like:
+```text
+INFO Registering runner, arch=amd64, os=darwin, version=0.1.5.
+WARN Runner in user-mode.
+INFO Enter the Gitea instance URL (for example, https://gitea.com/):
+http://localhost:3000/
+INFO Enter the runner token:
+fe884e8027dc292970d4e0303fe82b14xxxxxxxx
+INFO Enter the runner name (if set empty, use hostname:Test.local ):
+
+INFO Enter the runner labels, leave blank to use the default labels (comma-separated, for example, ubuntu-20.04:docker://node:16-bullseye,ubuntu-18.04:docker://node:16-buster):
+
+INFO Registering runner, name=Test.local, instance=http://localhost:3000/, labels=[ubuntu-latest:docker://node:16-bullseye ubuntu-22.04:docker://node:16-bullseye ubuntu-20.04:docker://node:16-bullseye ubuntu-18.04:docker://node:16-buster].
+DEBU Successfully pinged the Gitea instance server
+INFO Runner registered successfully.
+```
+
+### run
+
+```shell
+./act_runner daemon
+```
\ No newline at end of file