Skip to content

Commit

Permalink
Updating names and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sap1ens committed Jun 25, 2016
1 parent 0803de4 commit 7e734e9
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# syrup for your waffles

Little helper for [Waffle.io](https://waffle.io) based Scrum workflows, can also work with [ZenHub](https://www.zenhub.com) or just plain GitHub. Currently only supports CLI mode.
Scrum workflow CLI for GitHub with or without [Waffle.io](https://waffle.io). Can be also used with [ZenHub](https://www.zenhub.com). Currently only supports CLI mode.

Features:
- List all Sprints with associated issues and details
Expand All @@ -11,13 +11,13 @@ Features:

## Workflows

You can use plain GitHub or Waffle.io - in this case your workflow should be similar to what's covered in the **Waffle.io Workflow** section.
You can use GitHub with or without Waffle.io - in this case your workflow should be similar to what's covered in the **GitHub & Waffle.io Workflows** section.

If you use ZenHub you probably already have everything you need, but this app still can help you with milestones, check **ZenHub Workflow** section.

Also, in both cases `clone-issue` command can be helpful for moving tickets between Sprints.

## Waffle.io Workflow
## GitHub & Waffle.io Workflows

[Waffle.io](https://waffle.io) is an amazing project management tool based on GitHub. It has two-way synchronization with GitHub and shows
your issues for a repo as a Kanban board.
Expand Down Expand Up @@ -97,6 +97,7 @@ You can use this command for iterating:
## TODO

- Current Sprint view
- Make all label colors to be configurable
- Error handling
- Tests
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "syrup-cli",
"version": "0.9.2",
"description": "Scrum workflow CLI for Waffle.io. Can be used with ZenHub or plain GitHub.",
"version": "0.9.3",
"description": "Scrum workflow CLI for GitHub with or without Waffle.io. Can be also used with ZenHub.",
"main": "./lib/syrup.js",
"bin": {
"syrup": "bin/syrup.js"
Expand Down

0 comments on commit 7e734e9

Please sign in to comment.