Update readme

This commit is contained in:
Eric Neidhardt 2021-12-15 13:07:23 +01:00
parent 5a86b1426b
commit 1e0a90c36d

View File

@ -13,13 +13,25 @@ SPDX-License-Identifier: CC-BY-4.0
Just sleep for windows. Just sleep for windows.
## Getting started ## Quickstart
Make sure that docker is installed and checkout the project. Make sure that docker is installed and checkout the project.
```bash ```bash
make test make all
make build ```
## Installation
Simply grep the latest available binary from the release page and put it somewhere in your path.
If go is installed and $GOPATH/bin is in your path, you can download and install the tool directly
by using go install.
Download tool:
```bash
go install github.com/EricNeid/go-sleep/cmd/sleep@v0.2.0
``` ```
## Usage ## Usage