Skip to content

Commit

Permalink
chore(docs): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
epwalsh authored and github-actions[bot] committed Jul 26, 2024
1 parent a926b5e commit 247c69c
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions doc/pomo.txt
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,23 @@ COMMANDS *pomo-commands*
- `:TimerPause [TIMERID]` pause a timer. If no ID is given, the latest timer is
paused.
- `:TimerResume [TIMERID]` the opposite of `:TimerPause`.
- `:TimerSession [SESSION_NAME]` to start a predefined Pomodoro session.
Example session configuration in your setup:
>lua
require("pomo").setup({
sessions = {
pomodoro = {
{ name = "Work", duration = "25m" },
{ name = "Short Break", duration = "5m" },
{ name = "Work", duration = "25m" },
{ name = "Short Break", duration = "5m" },
{ name = "Work", duration = "25m" },
{ name = "Long Break", duration = "15m" },
},
},
})
<
To start the above session, use: `:TimerSession pomodoro`.



Expand Down Expand Up @@ -154,6 +171,18 @@ read each option carefully and customize it to your needs:
{ name = "System" },
},
},
-- You can optionally define custom timer sessions.
sessions = {
-- Example session configuration for a session called "pomodoro".
pomodoro = {
{ name = "Work", duration = "25m" },
{ name = "Short Break", duration = "5m" },
{ name = "Work", duration = "25m" },
{ name = "Short Break", duration = "5m" },
{ name = "Work", duration = "25m" },
{ name = "Long Break", duration = "15m" },
},
},
}
<

Expand Down

0 comments on commit 247c69c

Please sign in to comment.