Skip to content

Commit

Permalink
docs(README): πŸ“ README additions
Browse files Browse the repository at this point in the history
  • Loading branch information
goooseman committed Feb 16, 2019
1 parent 7cf467f commit 1990850
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions README.md
Expand Up @@ -23,6 +23,9 @@ Can parse a string in a format `1h20m30s`. Extra blocks (hours and minutes) can
`titimer 20m30s` - runs a timer for 20 minutes, 30 seconds
`titimer 30s` - runs a timer for 30 seconds

`titimer -v` - prints version
`titimer -h` - prints help

## TODO

- [ ] Make a pluralization for seconds output (now the output is `1 seconds`)
Expand All @@ -32,9 +35,9 @@ Can parse a string in a format `1h20m30s`. Extra blocks (hours and minutes) can

## Preview generation

`cd ..`
`asciinema rec titimer/extra/preview.cast`
`titimer 3s`
`CTRL+d`
`cd -`
`npx asciicast2gif -s 2 extra/preview.cast extra/preview.svg`
- `cd ..`
- `asciinema rec titimer/extra/preview.cast`
- `titimer 3s`
- `CTRL+d`
- `cd -`
- `npx asciicast2gif -s 2 extra/preview.cast extra/preview.svg`

0 comments on commit 1990850

Please sign in to comment.