From deff8c4738e3afddda59aad3eeb7b5ac0af4874a Mon Sep 17 00:00:00 2001 From: Miguel de la Cruz Date: Sat, 29 Feb 2020 14:38:32 +0100 Subject: [PATCH] Update the README with the current flow status --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4a4c2e5..18f3e1f 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,14 @@ Use "campaigner [command] --help" for more information about a command. ## Application flow 1. Run `campaigner set-token` to set the tokens for `jira/github`. -2. Run `campaigner create` to create a new community campaign. +2. Run `campaigner init` to create a new community campaign. 3. Run `campaigner add` to add new tickets based either on a `grep/ag` command or a `govet` check. -4. Run `campaigner state` to see the status of each one of the +4. Run `campaigner filter` to interactively remove false matches. +5. Run `campaigner status` to see the status of each one of the tickets. The tickets can be in an `unpublished`, `jira`, `github` and `completed` state. -5. Run `campaigner template` to edit the ticket template. -6. Run `campaigner publish` to create the tickets in `jira` based on +6. Modify the `template.md` file to adjust the ticket templates. +7. Run `campaigner publish` to create the tickets in `jira` based on the template. -7. Possible next step to publish the tickets from `jira` to `github`. +8. Possible next step to publish the tickets from `jira` to `github`.