From dfd8aeffa77bcca93be1cecf0561a15c8de1b112 Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Sat, 29 Feb 2020 01:22:11 +0100 Subject: [PATCH] Adds basic usage to the readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 7f4be9b..0d82b17 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,27 @@ Command line tool to create and manage community campaigns. +## Usage + +```sh +$ campaigner --help +Create and manage Open Source campaigns + +Usage: + campaigner [command] + +Available Commands: + add Adds tickets to the campaign + help Help about any command + init Creates a new campaign in the current directory + token Subcommands related to tokens + +Flags: + -h, --help help for campaigner + +Use "campaigner [command] --help" for more information about a command. +``` + ## Application flow 1. Run `campaigner set-token` to set the tokens for `jira/github`.