From 9ea6b5c407c3d3674fed6f313a0ded10907f5566 Mon Sep 17 00:00:00 2001 From: Jayson Reis Date: Thu, 20 May 2021 09:01:28 +0200 Subject: [PATCH] chore: Tidy up readme --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e295460..45c4897 100644 --- a/README.md +++ b/README.md @@ -28,9 +28,12 @@ SUBCOMMANDS: register-device ``` -The basic flow is calling `register-device` so mambembe can record your access token and save it to your keyring service (Keychain on macOS, secrets-manager on linux which is baked by KWallet or gnome-keyring, or Windows Vault). +The basic flow is calling `register-device` so mambembe can record your access token and save it to your keyring service (Keychain on macOS, secrets-manager on linux which is backed by KWallet or gnome-keyring, or Windows Vault). + To register your device call `mambembe-cli register-device --device-name --phone ` where **IMPORTANT** phone has to be in a specific format (as there is no cleaning in place) e.g.: `49-123456`, where `49` is the country code and `123456` is your phone. + To refresh your tokens you can call `list-services` and it will always hit authy's API to get the list of your current devices. + To get a token you can call `mambembe-cli get-token --service-name ` where `` can be a partial as it will make a fuzzy search, e.g.: ```