Skip to content

Commit

Permalink
readme: Improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
tmc committed Mar 7, 2021
1 parent f445049 commit a6afa67
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 1 deletion.
18 changes: 18 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
on: [push, pull_request]
name: Test
jobs:
test:
strategy:
matrix:
go-version: [1.15.x, 1.16.x]
os: [macos-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Install Go
uses: actions/setup-go@v2
with:
go-version: ${{ matrix.go-version }}
- name: Check out code
uses: actions/checkout@v2
- name: Test
run: go test -race ./...
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,29 @@
# clocks

Command clocks places additional time zones into your mac status bar.
[![Project status](https://img.shields.io/github/release/tmc/clocks.svg?style=flat-square)](https://github.com/tmc/clocks/releases/latest)
[![Build Status](https://github.com/tmc/clocks/workflows/Test/badge.svg)](https://github.com/tmc/clocks/actions?query=workflow%3ATest)
[![Go Report Card](https://goreportcard.com/badge/tmc/clocks?cache=0)](https://goreportcard.com/report/tmc/clocks)
[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/tmc/clocks)

Command clocks places additional time zones into your Mac status bar.

## Installation

clocks is a [Go](https://golang.org/) program for MacOS systems.

## Usage

```console
$ clocks -h
Usage of clocks:
-fmt string
time format string (golang time pkg) (default "Mon Jan 2 15:04 MST")
-tzs string
time zones (default "UTC,America/Los_Angeles")
```

## Example Output

This is example output from running `clocks`:

![example output](./docs/example-statusbar-image.png)
Binary file added docs/example-statusbar-image.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 a6afa67

Please sign in to comment.