Skip to content

Commit

Permalink
readme: add quick start
Browse files Browse the repository at this point in the history
  • Loading branch information
can3p committed Jan 11, 2024
1 parent de46ca5 commit 75f9224
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,21 @@ The script will install the binary into `$HOME/bin` folder by default, you can o
Get the archive that fits your system from the [Releases](https://github.com/can3p/kleiner/releases) page and
extract the binary into a folder that is mentioned in your `$PATH` variable.

## Quick start

* Install kleiner and it's dependencies
* Create a new repo on github
* Clone it to make sure you have origin set up
* `go mod init <username>/<repo>`
* `kleiner generate`
* `go mod tidy`
* Commit and push
* Make sure that you have `$GITHUB_TOKEN` in the environment
* `kleiner release -tag-comment "first release"`
* That's it!

For every next release just work on you changes, push them and run `kleiner release` again to publish a new version

## Inspiration

The code is inspired a lot and uses parts of the [flyctl](https://github.com/superfly/flyctl) code. The files
Expand Down

0 comments on commit 75f9224

Please sign in to comment.