README.md in checkcheckit-0.1.2 vs README.md in checkcheckit-0.1.3
- old
+ new
@@ -1,34 +1,51 @@
# Check, Check, It
use checklists, like a boss
+CheckCheckIt is a ruby library that exposes the command line program `check` and companion web service that makes the process of going through a checklist easy to sync across multiple people.
+
+Right now everything begins at the command line and a directory of checklists.
+
+A "checklist" is just a text file.
+Every line that starts with a dash '-' is a step.
+Everything beneath a step is that step's body or description.
+
## Installation
$ gem install checkcheckit
-## TODO
+## Usage
-- resume a run
- - locally
+ # list your checklists
+ $ check list
+ # Checklists
+ personal
+ groceries
+ work
+ deploy
-- post to campfire
+ # start a list at the command line and keep it there
+ $ check start deploy
+ |-------| Step 1: Pull everything from git
+ > git pull origin
+ Check: ^C
+ Goodbye!
-## Usage
+ # start a list, open it in your browser, and skip the CLI interaction
+ $ check start groceries --live --web --open
+ $ check start groceries --live --no-cli -O
+ Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
### `list` the checklists
`checkcheckit` assumes a home directory of ~/checkcheckit
In that directory are folders for your organizations, groups, etc.
In those folders are your checklists.
-A "checklist" is just a text file.
-Every line that starts with a dash '-' is a step.
-Everything beneath a step is that step's body or description.
-
$ check list
# Checklists
heroku
todo
personal
@@ -71,21 +88,49 @@
Check: failures!
Notes: <enter>
### Live mode
-This is fun. Specify an email (or a comma-separated list) on the command line and
-that address will receive a message with a link to a web version of the checklist.
+This is fun.
-Right now the cmd line client and web don't interact. For now.
+`check start <listname> --live` will create an _interactive_ companion URL on the web.
- $ check start deploy --email me@me.com,another.guy@gmail.com
- |-------| Step 1: Pull everything from git
- > git pull origin
+This URL is websockets-enabled and communicates with the command line.
+This means command line 'checks' get pushed to the web. Once a list is on the web you can
+disconnect the command line and continue finishing it (with others).
- You'll get an email with a link:
+ $ check start deploy --live
+ Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
+ Websocket refused connection - using POST
+ |........| Step 1: Make sure there are no uncommitted changes
+ > `git status`
+ Check:
- http://checkcheckit.herokuapp.com/1
+ |+.......| Step 2: Pull everything from git
+ > `git pull`
+ Check: ^C
+ bye
+
+During that console session the web UI would be interactively crossing items off the list:
+<img height="400px" src="http://f.cl.ly/items/1h3V0L1a1p1a062I2X3f/Screen%20Shot%202012-12-16%20at%209.37.56%20PM.png" />
+
+### Email
+Specify an email (or a comma-separated list) on the command line via the `--email` flag and
+the address(es) will receive an email with a link to a web version of the checklist.
+
+
+ $ check start deploy --email bob@work.com,steve@work.com
+ Live at URL: http://checkcheckit.herokuapp.com/4f24b9d933d5467ec913461b8da3f952dbe724cb
+ Websocket refused connection - using POST
+ |........| Step 1: Make sure there are no uncommitted changes
+ > `git status`
+ Check: ^C
+ bye
+
+## TODO
+
+- resume a run locally from URL
+- post to campfire
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)