Skip to content

Commit

Permalink
README πŸ’…
Browse files Browse the repository at this point in the history
  • Loading branch information
oz committed Mar 16, 2021
1 parent a61c136 commit 877270d
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,19 @@ harmed if you build from source.

# Usage

Start tz to show the local time, as well as the UTC time zone. It's
nicer to set the `TZ_LIST` environment variable with a comma-separated
list of [tz data][tzdata] zone names:

[tzdata]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
Simply run `tz` with no arguments to show the local time, as well as the
UTC time zone. It gets more interesting once you set the `TZ_LIST`
environment variable with a comma-separated list of [tz data][tzdata]
zone names.

<p align="center">
<img align="center" src="./docs/demo.gif" />
<img align="center" src="./docs/tz.png" />
</p>

The program will adjust to light and dark terminals themes.

[tzdata]: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

# Configuration

## Zone Alias
Expand All @@ -32,10 +35,18 @@ tz name followed by `;` and your alias:

# Building

Clone this repository and run:
You need a recent-ish release of go with modules support:

```
git clone https://github.com/oz/tz
cd tz
go build
```

# Testing

```
go build .
go test -cover
```

# License
Expand Down
Binary file removed docs/demo.gif
Binary file not shown.
Binary file added docs/tz.png
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 877270d

Please sign in to comment.