Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
antonmedv committed Mar 9, 2023
1 parent 10db737 commit b26823c
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 22 deletions.
5 changes: 0 additions & 5 deletions .github/demo.tape

This file was deleted.

35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,54 @@
# Countdown

<p align="center"><img src="https://user-images.githubusercontent.com/141232/54696023-9ed03e00-4b5d-11e9-9c7b-d6f67691e70c.gif" width="450" alt="Screen shot"></p>
<p align="center">
<br>
<img src="demo.gif" width="600" alt="Countdown Demo">
<br>
</p>

## Install

```bash
```sh
brew install countdown
```

```sh
go install github.com/antonmedv/countdown@latest
```

Or download prebuilt binary from [releases](https://github.com/antonmedv/countdown/releases).

## Usage

Specify duration in Go format `1h2m3s`.
Specify duration in Go format `1h2m3s` or a target time: `02:15pm`, `14:15`.

```bash
```sh
countdown 25s
```

Or specify target time: `02:15PM` or `14:15`. For instance, if the current time
would be 11:30, the next example would trigger a 2-minute countdown.

```bash
countdown 11:32
```

Add a command with `&&` to run after the countdown.

```bash
```sh
countdown 1m30s && say "Hello, world"
```

Count from up from the zero.

```bash
```sh
countdown -up 30s
```

Announce (via macOS `say` command) last 10 seconds
Announce (via macOS `say` command) last 10 seconds.

```bash
```sh
countdown -say 10s
```

## Key binding

- `p` or `P`: To pause the countdown.
- `c` or `C`: To resume the countdown.
- `Esc` or `Ctrl+C`: To stop the countdown without running next command.
- `Space`: Pause/Resume the countdown.
- `Esc` or `Ctrl+C`: Stop the countdown without running the next command.

## License

Expand Down
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b26823c

Please sign in to comment.