Skip to content

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
Signed-off-by: Carlos Alexandro Becker <caarlos0@gmail.com>
  • Loading branch information
caarlos0 committed May 3, 2021
1 parent 716f79a commit c409d0e
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# tasktimer
<p align="center">
<img alt="header image" src="https://raw.githubusercontent.com/caarlos0/tasktimer/main/static/undraw_Dev_focus_re_6iwt.svg" height="250" />
<h1 align="center">tasktimer</h1>
<p align="center">Task Timer (<code>tt</code>) is a dead simple TUI task timer.</p>
</p>

[![Release](https://img.shields.io/github/release/caarlos0/tasktimer.svg?style=flat-square)](https://github.com/caarlos0/tasktimer/releases/latest)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build](https://img.shields.io/github/workflow/status/caarlos0/tasktimer/build?style=flat-square)](https://github.com/caarlos0/tasktimer/actions?query=workflow%3Abuild)
[![Go Report Card](https://goreportcard.com/badge/github.com/caarlos0/tasktimer?style=flat-square)](https://goreportcard.com/report/github.com/caarlos0/tasktimer)
[![Godoc](https://godoc.org/github.com/caarlos0/tasktimer?status.svg&style=flat-square)](http://godoc.org/github.com/caarlos0/tasktimer)
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square)](https://github.com/goreleaser)
---

Task Timer (`tt`) is a dead simple TUI task timer

![](/static/undraw_Dev_focus_re_6iwt.svg)
## Usage

To get started, just run `tt`:
Expand Down Expand Up @@ -132,3 +128,12 @@ rm -rf ~/tasktimer # delete old folder

[Badger]: https://github.com/dgraph-io/badger
[releases]: https://github.com/caarlos0/tasktimer/releases

# Badges

[![Release](https://img.shields.io/github/release/caarlos0/tasktimer.svg?style=flat-square)](https://github.com/caarlos0/tasktimer/releases/latest)
[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)
[![Build](https://img.shields.io/github/workflow/status/caarlos0/tasktimer/build?style=flat-square)](https://github.com/caarlos0/tasktimer/actions?query=workflow%3Abuild)
[![Go Report Card](https://goreportcard.com/badge/github.com/caarlos0/tasktimer?style=flat-square)](https://goreportcard.com/report/github.com/caarlos0/tasktimer)
[![Godoc](https://godoc.org/github.com/caarlos0/tasktimer?status.svg&style=flat-square)](http://godoc.org/github.com/caarlos0/tasktimer)
[![Powered By: GoReleaser](https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square)](https://github.com/goreleaser)

0 comments on commit c409d0e

Please sign in to comment.