Skip to content

Commit

Permalink
Better readme, better help
Browse files Browse the repository at this point in the history
  • Loading branch information
simonharrer committed Mar 28, 2020
1 parent 4020498 commit c3c02ec
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 19 deletions.
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,22 @@ It keeps your master branch clean and creates WIP commits on `mob-session` branc
## How to use it?

```bash
# simon begins the mob session as typist
simon$ mob start 10
# WORK
# after 10 minutes...
simon$ mob next
# carola takes over as the second typist
carola$ mob start 10
# WORK
# after 10 minutes...
carola$ mob next
simon$ mob start 10
# Simon begins the mob session as typist
Simon $ cd secret-git-project
Simon $ mob start 10
# WORK with Simon as typist
# after 10 minutes, the timer triggers (you'll hear a 'mob next' from your speakers)
Simon $ mob next
# Carola takes over as the second typist
Carola $ mob start 10
# WORK with Carola as typist
# after 10 minutes, timer triggers...
Carola $ mob next
Maria $ mob start 10 share # share immediately activates zoom screenshare
# WORK
# After 6 minutes the work is done.
simon$ mob done
simon$ git commit --message "describe what the mob session was all about"
Maria $ mob done
Maria $ git commit --message "describe what the mob session was all about"
```

## How does it work?
Expand All @@ -36,6 +37,10 @@ simon$ git commit --message "describe what the mob session was all about"
- `mob status` display the mob session status and all the created WIP commits
- `mob reset` deletes `mob-session` and `origin/mob-session`

### Zoom Screenshare

The `mob share` feature only works if you activate make the screenshare hotkey in zoom globally available, and keep the default shortcut at CMD+SHIFT+S.

## How to install

```bash
Expand Down
6 changes: 4 additions & 2 deletions mob.go
Original file line number Diff line number Diff line change
Expand Up @@ -338,13 +338,15 @@ func help() {
say("\tmob [d]one \t# finish mob session")
say("\tmob [r]eset \t# resets any unfinished mob session")
say("\tmob status \t# show status of mob session")
say("\tmob share \t# start screenshare with zoom")
say("\tmob --help \t# prints this help")
say("\tmob --version \t# prints the version")
say("")
say("examples")
say("\t mob start 10 \t# start session with 10 min.")
say("\t mob start 10 \t# start 10 min session")
say("\t mob start 10 share \t# start 10 min session with zoom screenshare")
say("\t mob next \t# after 10 minutes work ...")
say("\t mob done \t# After the work is done.")
say("\t mob done \t# After the work is done")

}

Expand Down
2 changes: 0 additions & 2 deletions mute

This file was deleted.

2 changes: 0 additions & 2 deletions share

This file was deleted.

0 comments on commit c3c02ec

Please sign in to comment.