From b4d2a6464200751e0bf818e0d1587a60344c1133 Mon Sep 17 00:00:00 2001
From: KunoiSayami <46131041+KunoiSayami@users.noreply.github.com>
Date: Mon, 17 May 2021 00:51:00 +0800
Subject: refactor(core): Rebuilt the subcommand structure * refactor(test):
 Rename mod from core_test to core

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

(limited to 'README.md')

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
-- 
cgit v1.3.1