Adds basic usage to the readme

This commit is contained in:
Miguel de la Cruz 2020-02-29 01:22:11 +01:00
parent fe1c3e4c9c
commit dfd8aeffa7

View file

@ -2,6 +2,27 @@
Command line tool to create and manage community campaigns. 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 ## Application flow
1. Run `campaigner set-token` to set the tokens for `jira/github`. 1. Run `campaigner set-token` to set the tokens for `jira/github`.