Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
pablotrianda authored Jun 25, 2022
1 parent 6bfc7b5 commit 67bc746
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -9,16 +9,13 @@ A pomodoro terminal app!

## Install
1. Run `install.sh`
2. Run `$pomodorox`
2. Run `pomodorox 50 10 4`

## Configuration
To configure the [pomodoro](https://es.wikipedia.org/wiki/T%C3%A9cnica_Pomodoro) times and loops you must set the values on
`~/.config/pomodorox/config.yaml` \n
Disclaimer: This configurations is the way what **work for me!**, you can modify for your need. 😉
This app take 3 params:
* `workLoops` -> The number of block of work
* `timeWorkLoops` -> Time for each work block
* `timePause` -> Time for each pause block
## Use
Run the command with 3 paramenters: *Time to work* - *time of pause* - *Quantity loops*

Use:
`$pomodorox 50 10 4`

## Images
### Nofifications (Linux only)
@@ -33,5 +30,4 @@ This app take 3 params:
# Next steps
- [ ] Show times and loops on tmux bar.
- [ ] Use params to set the loops.
- [ ] More configurations modes.
- [ ] Show a time countdown

0 comments on commit 67bc746

Please sign in to comment.