From f3561b5efd0b8aeb8e54e1c6e34c336b594b0146 Mon Sep 17 00:00:00 2001 From: Awiteb Date: Sat, 16 Nov 2024 11:47:54 +0000 Subject: [PATCH] chore: Update `README.md` Signed-off-by: Awiteb --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4161c60..f914f3e 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ You can let [cargo](https://doc.rust-lang.org/cargo/) build the binary for you, > [!TIP] > This will install the binary in `~/.cargo/bin/forgejo-guardian`. Make sure to add this directory to your `PATH`. -> If you want to update it, run `cargo install ...` again. +> If you want to update it, rerun the command. ```sh cargo install --git https://git.4rs.nl/awiteb/forgejo-guardian @@ -55,17 +55,18 @@ We use `TOML` format for configuration, the default configuration file is `/app/ ### Structure -In our configuration file you can have the following sections and the global sections: +In our configuration file you can have the following sections and the global section: - `forgejo`: Forgejo instance configuration - `expressions`: Regular expressions to match against - `telegram`: Telegram bot configuration -#### Global sections +#### Global section The global section is the one that doesn't have a name, and it's in the top of the configuration file, with the following fields: - `dry_run`: If set to `true`, the guardian will not ban the users, but will only alert the admins (default: `false`) +- `only_new_users`: If set to `true`, the guardian will only check the new users, and not the existing ones (default: `false`) #### `forgejo`