fix readme format

This commit is contained in:
Thiago Macedo 2019-03-11 23:52:49 -03:00
parent f9fb39bfcc
commit fbd5ca62a7
2 changed files with 26 additions and 17 deletions

View file

@ -4,8 +4,13 @@ timers:
apps: apps:
- retroarch - retroarch
- minecraft - minecraft
- atom
# how many minutes of usage # how many minutes of usage
time-limit: 3 time-limit: 60
# within how many hours of interval # within how many hours of interval
limit-interval: 0.1 limit-interval: 12
pomodoro:
apps:
- atom
- sublime_text
time-limit: 30
limit-interval: 45

View file

@ -8,6 +8,7 @@ I'm using this at a raspberry pi gaming station to enforce usage limits.
## Config ## Config
```yaml
# how often should the script check for apps runtime? # how often should the script check for apps runtime?
check-interval: 1 check-interval: 1
# timers: list of apps that will be watched # timers: list of apps that will be watched
@ -22,12 +23,15 @@ I'm using this at a raspberry pi gaming station to enforce usage limits.
time-limit: 60 time-limit: 60
# within how many hours of interval # within how many hours of interval
limit-interval: 12 limit-interval: 12
```
## Installation ## Installation
There's a systemd service file ready for use. There's a systemd service file ready for use.
```bash
cp ./timer.service /etc/systemd/system/app-timer.service cp ./timer.service /etc/systemd/system/app-timer.service
systemctl enable app-timer systemctl enable app-timer
```
Update this file to point `ExecStart` into your setup folder. Update this file to point `ExecStart` into your setup folder.