From 95cbd5fab45d788c4e786aec74a5108b3276e405 Mon Sep 17 00:00:00 2001
From: Jamil Bou Kheir <jamil@elbii.com>
Date: Tue, 5 Oct 2021 19:47:54 +0000
Subject: [PATCH] Update README with new format

---
 README.md                                                 | 8 +++++---
 .../firezone/files/default/ctl-commands/create_admin.rb   | 2 +-
 .../firezone/files/default/ctl-commands/reset_network.rb  | 2 +-
 3 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 39386c1e3..28adba641 100644
--- a/README.md
+++ b/README.md
@@ -156,7 +156,7 @@ listed above, follow these steps to setup and install Firezone:
    default['firezone']['ssl']['certificate_key'] = '/path/to/key.pem'
    ```
 6. Reconfigure the application to pick up the new changes: `sudo firezone-ctl reconfigure`.
-7. Finally, create an admin user with `sudo firezone-ctl create_admin`.
+7. Finally, create an admin user with `sudo firezone-ctl create-admin`.
    The login credentials will be printed to the console output.
 8. Now you should be able to log into the web UI at the FQDN you specified in
    step 5 above, e.g. `https://firezone.example.com`
@@ -177,15 +177,17 @@ Your Firezone installation can be managed via the `firezone-ctl` command, as sho
 root@demo:~# firezone-ctl
 I don't know that command.
 omnibus-ctl: command (subcommand)
-create_admin
-  Create an Admin user
 General Commands:
   cleanse
     Delete *all* firezone data, and start from scratch.
+  create-admin
+    Create an Admin user.
   help
     Print this help message.
   reconfigure
     Reconfigure the application.
+  reset-network
+    Resets nftables, WireGuard interface, and routing table back to Firezone defaults.
   show-config
     Show the configuration that would be generated by reconfigure.
   uninstall
diff --git a/omnibus/cookbooks/firezone/files/default/ctl-commands/create_admin.rb b/omnibus/cookbooks/firezone/files/default/ctl-commands/create_admin.rb
index 02ac26686..afecdb63e 100644
--- a/omnibus/cookbooks/firezone/files/default/ctl-commands/create_admin.rb
+++ b/omnibus/cookbooks/firezone/files/default/ctl-commands/create_admin.rb
@@ -2,7 +2,7 @@
 
 require 'mixlib/shellout'
 
-add_command_under_category 'create-admin', 'general', 'Create an Admin user', 2 do
+add_command_under_category 'create-admin', 'general', 'Create an Admin user.', 2 do
   command = %W(
     chef-client
     -z
diff --git a/omnibus/cookbooks/firezone/files/default/ctl-commands/reset_network.rb b/omnibus/cookbooks/firezone/files/default/ctl-commands/reset_network.rb
index 6b751f07d..f475197cc 100644
--- a/omnibus/cookbooks/firezone/files/default/ctl-commands/reset_network.rb
+++ b/omnibus/cookbooks/firezone/files/default/ctl-commands/reset_network.rb
@@ -3,7 +3,7 @@
 require "mixlib/shellout"
 
 add_command_under_category "reset-network", "general", "Resets nftables, WireGuard interface, "\
-  "and routing table back to Firezone defaults", 2 do
+  "and routing table back to Firezone defaults.", 2 do
   command = %W(
     chef-client
     -z