aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 36 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6433a8c..83337aa 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,7 @@ cgit-simple-auth-full-protect=true
Available options for repositories:
-_Should set `cgit-simple-auth-full-protect=false`_
+_You should set `cgit-simple-auth-full-protect=false`_
```conf
repo.url=test
@@ -33,6 +33,41 @@ repo.url=test
repo.protect=true
```
+## Usage
+
+You should initialize your database first
+
+```shell
+cargo run -- database init
+```
+
+Then add user with
+
+```shell
+cargo run -- user add admin hunter2
+```
+
+More usage information, see `--help`.
+
+## Program help
+
+```plain
+Simple Authentication Filter for cgit
+
+USAGE:
+ cgit-simple-authentication.exe [SUBCOMMAND]
+
+FLAGS:
+ -h, --help Prints help information
+ -V, --version Prints version information
+
+SUBCOMMANDS:
+ database Database rated commands
+ repo Repository ACL rated commands
+ user Users rated commands
+ help Prints this message or the help of the given subcommand(s)
+```
+
## Source
Most of the ideas come from: https://github.com/varphone/cgit-gogs-auth-filter