Add usage to README

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
index 0b5b06f..404febc 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,16 @@
 
 It handles client creation and removal, and will auto-generate the corresponding private and public keys. It can also generate the configuration file for each client.
 
+Be aware that the clients' private keys will be stored on the server in order to simplify the config file generation. This is par for the course for Wireguard managers, but it bears repeating.
+
+```
+$ wgmgr add my_new_laptop
+$ wgmgr ls
+my_new_laptop | 10.8.0.2
+$ wgmgr config --type split my_new_laptop
+<copy-paste the configuration to your laptop>
+```
+
 ## Setting up
 
 Create the application configuration file, at `/etc/wgmgr.toml`:
@@ -24,6 +34,26 @@ ListenPort = 51820
 Address = 10.8.0.1/24
 ```
 
+## Usage
+
+```
+Usage: wgmgr [OPTIONS] <COMMAND>
+
+Commands:
+  ls      List known clients
+  config  Generate the configuration file for a client
+  add     Add a new client to your VPN
+  rm      Remove a client from your VPN
+  wg      Run 'wg', but with the client names
+  help    Print this message or the help of the given subcommand(s)
+
+Options:
+  -w, --wgconfig <WGCONFIG>  Wireguard configuration file name
+  -c, --config <CONFIG>      wgmgr configuration file path
+  -h, --help                 Print help
+  -V, --version              Print version
+```
+
 ## Reporting bugs
 
 Please report any bugs you find to [bugs+wgmgr@sixfoisneuf.fr](mailto:bugs+wgmgr@sixfoisneuf.fr). Contributions are welcomed, as long as they follow the [git send-email](https://git-send-email.io) format.