Skip to content

Commit

Permalink
docs: add README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rami3l committed Nov 13, 2020
1 parent 3b29cab commit 91bca36
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- [ting](#ting)
- [Contents](#contents)
- [Motivation & Current Status](#motivation--current-status)
- [Build & Installation](#build--installation)
- [Usage & Options](#usage--options)

## Motivation & Current Status
Expand All @@ -17,6 +18,24 @@ but gets potentially broken when the `Python` interpreter gets updated.
Thus, using `Golang` enables me to solve the problem almost as efficiently, with the additional benefit of
being able to easily distribute the binaries.

## Build & Installation

- `homebrew` install:

```bash
brew install rami3l/tap/ting
```

- Build from source:

```bash
# To install:
go install github.com/rami3l/ting

# To uninstall:
go clean -i "github.com/rami3l/ting"
```

## Usage & Options

Usage: `ting [hosts...] [flags]`
Expand Down

0 comments on commit 91bca36

Please sign in to comment.