Skip to content

Commit

Permalink
docs: add badges and better installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
matty-rose committed Oct 24, 2021
1 parent 23ebcb2 commit 3995679
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# gha-docs

[![test](https://img.shields.io/github/workflow/status/matty-rose/gha-docs/Test%20GHA%20Docs)](https://github.com/matty-rose/gha-docs/actions/workflows/test.yaml)
[![coverage](https://img.shields.io/codecov/c/github/matty-rose/gha-docs)](https://codecov.io/gh/matty-rose/gha-docs)
[![Go Reference](https://pkg.go.dev/badge/github.com/matty-rose/gha-docs.svg)](https://pkg.go.dev/github.com/matty-rose/gha-docs)
[![Go Report Card](https://goreportcard.com/badge/github.com/matty-rose/gha-docs)](https://goreportcard.com/report/github.com/matty-rose/gha-docs)
[![license](https://img.shields.io/github/license/matty-rose/gha-docs)](https://github.com/matty-rose/gha-docs/blob/main/LICENSE)
[![release](https://img.shields.io/github/v/release/matty-rose/gha-docs)](https://github.com/matty-rose/gha-docs/releases)

## Installation

### Stable Release Binaries
Substitute `darwin` for `linux` if installing on MacOS.

```bash
Expand All @@ -12,3 +21,15 @@ curl -LO https://github.com/matty-rose/gha-docs/releases/download/$GHA_DOCS_VERS
tar -xzf gha-docs-$GHA_DOCS_VERSION-$GHA_DOCS_OS-$GHA_DOCS_ARCH.tar.gz
chmod +x gha-docs && mv gha-docs /usr/local/bin
```

### From Source

Go `1.17+` is required.

```bash
go install github.com/matty-rose/[email protected]
```

## License

MIT License - Copyright (c) 2021

0 comments on commit 3995679

Please sign in to comment.