Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Thanh Nguyen committed Sep 6, 2020
1 parent 3e2cc40 commit f57d602
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,36 +13,34 @@ Latest version: [v0.5.0](RELEASE-NOTES.md).

## Installation

> `go-giter8` is go-module enabled. Therefore, it must be installed/upgraded in go-module mode.
> `go-giter8` is go-module enabled. Therefore, it must be installed/upgraded in go-module mode by setting `GO111MODULE=on`.
You can install `go-giter8` using the standard go deployment tool. This will install g8 as ```$GOPATH/bin/g8```:

```
GO111MODULE=on && go get github.com/btnguyen2k/go-giter8/g8
export GO111MODULE=on && go get github.com/btnguyen2k/go-giter8/g8
```

or you can specified a specific version:

```
GO111MODULE=on && go get github.com/btnguyen2k/go-giter8/g8@v0.5.0
export GO111MODULE=on && go get github.com/btnguyen2k/go-giter8/g8@v0.5.0
```

### Upgrading

At any point you can upgrade `g8` using the following:

```
GO111MODULE=on && go get -u github.com/btnguyen2k/go-giter8/g8
export GO111MODULE=on && go get -u github.com/btnguyen2k/go-giter8/g8
```

or you can specified a specific version:

```
GO111MODULE=on && go get -u github.com/btnguyen2k/go-giter8/g8@v0.5.0
export GO111MODULE=on && go get -u github.com/btnguyen2k/go-giter8/g8@v0.5.0
```

> GO111MODULE mode must be turned on in order to install/update `go-giter8`.
## Giter8 template

For information on Giter8 templates, please see [http://www.foundweekends.org/giter8/](http://www.foundweekends.org/giter8/).
Expand Down

0 comments on commit f57d602

Please # to comment.