Skip to content

Commit

Permalink
updated readme, added github workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
abenz1267 committed Feb 19, 2023
1 parent 41b9f7f commit 6575cb2
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
on:
release:
types: [created]

jobs:
releases-matrix:
name: Release Go Binary
runs-on: ubuntu-latest
strategy:
matrix:
# build and publish in parallel: linux/386, linux/amd64, linux/arm64, windows/386, windows/amd64, darwin/amd64, darwin/arm64
goos: [linux, windows, darwin]
goarch: ["386", amd64, arm64]
exclude:
- goarch: "386"
goos: darwin
- goarch: arm64
goos: windows
steps:
- uses: actions/checkout@v2
- uses: wangyoucao577/[email protected]
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
goos: ${{ matrix.goos }}
goarch: ${{ matrix.goarch }}
goversion: "https://dl.google.com/go/go1.20.1.linux-amd64.tar.gz"
project_path: "."
binary_name: "pww"
extra_files: LICENSE README.md
12 changes: 12 additions & 0 deletions readme.md → README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,20 @@ This is a simple program that emits a json with metadata info you can use in f.e

## Install

### Download binary

Simply download a pre-built binary from the [release page](https://github.com/abenz1267/pww/releases)

### With Go

Regular `GOBIN` folder (make sure it's in your `PATH`):
`go install github.com/abenz1267/pww@latest`

Install to custom location:
`GOBIN=<custom location> go install github.com/abenz1267/pww@latest`

f.e. `sudo GOBIN=/usr/bin/ go install github.com/abenz1267/pww@latest`

## Usage

| command | description | example |
Expand Down

0 comments on commit 6575cb2

Please sign in to comment.