From 401959f196a90b16fe3aa92810f89f1f145bccda Mon Sep 17 00:00:00 2001 From: Felix Breidenstein Date: Mon, 24 Feb 2020 17:00:04 +0100 Subject: [PATCH] Added instructions to README --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- cmd/list.go | 2 +- cmd/root.go | 2 +- 3 files changed, 46 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4862477..fd234a7 100644 --- a/README.md +++ b/README.md @@ -1 +1,44 @@ -d5td xsru qasx caxs m5q5 pv76 keui v7hr +# shared-2fa + +This tool helps you to share a virtual TOTP MFA-device with a team by saving the intial seed at AWS SecretsManager. + +``` +Available Commands: + add Create a new entry + delete Delete an entry + generate Generate a token for the given entry + help Help about any command + list A brief description of your command +``` + +## add +``` +Create a new entry + +Usage: + shared-2fa add +``` + +## delete +``` +Delete an entry + +Usage: + shared-2fa delete +``` + +## generate +``` +Generate a token for the given entry + +Usage: + shared-2fa generate +``` + +## list +``` +List all available entries + +Usage: + shared-2fa list +``` diff --git a/cmd/list.go b/cmd/list.go index b119465..38db1d0 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -14,7 +14,7 @@ import ( var listCmd = &cobra.Command{ Use: "list", - Short: "A brief description of your command", + Short: "List all available entries", Run: func(cmd *cobra.Command, args []string) { svc := secretsmanager.New(session.New(&aws.Config{ Region: aws.String(config.AWS_REGION), diff --git a/cmd/root.go b/cmd/root.go index 7b03176..6094603 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -12,7 +12,7 @@ var cfgFile string // rootCmd represents the base command when called without any subcommands var rootCmd = &cobra.Command{ Use: "shared-2fa", - Short: "A brief description of your application", + Short: "Tool to save TOTP seed in AWS SecretsManager and use for token generation", } // Execute adds all child commands to the root command and sets flags appropriately.