Verified Commit 8f7ab26e authored by (Holloway), Chew Kean Ho's avatar (Holloway), Chew Kean Ho 🤘🏼
Browse files

root: releasing v0.0.1



The patch marks the release of v0.0.1 godocgen.
Signed-off-by: (Holloway), Chew Kean Ho's avatar(Holloway) Chew, Kean Ho <kean.ho.chew@zoralab.com>
parent 231f3d4f
Pipeline #131729603 passed with stages
in 2 minutes and 10 seconds
......@@ -25,15 +25,32 @@ Godocgen has a number of ways to install as a program in your operating system.
Let's look at these supported methods.
## Go Get
To install via `go get`, you simply do:
To install via `go get`, you simply do `go get` against a release branch
version:
```bash
$ go get gitlab.com/zoralab/godocgen/cmd/godocgen
$ go get gitlab.com/zoralab/godocgen/cmd/godocgen@releases-VERSION
```
> **NOTE**: we decided to use branching over tagging mainly because the current
> version folder enforcement forces people to do code duplications and messed up
> user guides. Due to the enforcement, it is better to use protective branches
> to go get over tagging.
This will install the binary automatically inside your `$GOBIN` (or
`$GOPATH/bin` path).
### Supported Versions
These are the supported versions:
```bash
$ go get gitlab.com/zoralab/godocgen/cmd/godocgen@releases-v0.0.1
```
## DEB Package (Coming Soon)
The DEB package server hosting is planned and will be supported soon.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment