diff --git a/README.md b/README.md index e1626dd8..ef8af6d3 100644 --- a/README.md +++ b/README.md @@ -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? @@ -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 diff --git a/mob.go b/mob.go index 92f7d12a..1aab20f8 100644 --- a/mob.go +++ b/mob.go @@ -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") } diff --git a/mute b/mute deleted file mode 100755 index 93796409..00000000 --- a/mute +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -osascript -e 'tell application "System Events" to keystroke "A" using {shift down, command down}' diff --git a/share b/share deleted file mode 100755 index 73741401..00000000 --- a/share +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/sh -osascript -e 'tell application "System Events" to keystroke "S" using {shift down, command down}'