From 75f922423ed9dc85bdf4cf4a2dc4681ec1bb166f Mon Sep 17 00:00:00 2001 From: Dmitry Petrov Date: Thu, 11 Jan 2024 01:25:35 +0100 Subject: [PATCH] readme: add quick start --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 1ac84c9..4e59d35 100644 --- a/README.md +++ b/README.md @@ -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 /` +* `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