Skip to content

Update usage and install instructions in README according to the latest v4 package name #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aries-zhang wants to merge 1 commit into
base: master
Choose a base branch
from
+3 −5
Open

Update usage and install instructions in README according to the latest v4 package name #117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ when a null transform spec is specified, but may also be useful for testing.
To start, go get the versioned repository:

```sh
go get gopkg.in/qntfy/kazaam.v3
go get github.com/qntfy/kazaam/v4
```

### Using as an executable program
Expand All @@ -465,14 +465,12 @@ If you want to create an executable binary from this project, follow
these steps (you'll need `go` installed and `$GOPATH` set):

``` shell
go get gopkg.in/qntfy/kazaam.v3
cd $GOPATH/src/gopkg.in/qntfy/kazaam.v3/kazaam
go install
go install https://github.com/qntfy/kazaam/kazaam@latest
Copy link
Copy Markdown

@56KBs 56KBs Sep 1, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
go install https://github.com/qntfy/kazaam/kazaam@latest
go install github.com/qntfy/kazaam/kazaam@latest

However, the layout of this repository means v3.4.9 is installed instead of v4.0.1 (The current latest)

```

This will create an executable in `$GOPATH/bin` like you
would expect from the normal `go` build behavior.

### Examples

See [godoc examples](https://godoc.org/pkg/gopkg.in/qntfy/kazaam.v3/#pkg-examples).
See [godoc examples](https://pkg.go.dev/github.com/qntfy/kazaam/v4#pkg-examples).