doc: update usages for v1.1 #111
Conversation
Bobgy
changed the title
Bobgy
changed the title
There was a problem hiding this comment.
Actually, I'm not sure if we want to have "v2" docs now that we're tracking in the main branch. 🤔
This refers to a version that doesn't technically exist. Let's aim to keep the main README up to date with the current HEAD? We can always maintain versioned docs through release branches.
I'm not sure we want to keep README up to date with the HEAD, because HEAD remains to be the major user facing entrance for documentation. When people visit github.com/google/go-licenses, they immediately see what's in master branch. I think we can only update default README after maybe a beta release of v2. For now, I'm proposing this PR -- add a link to point people to the v2 README if they want to try it early and fully fork v2 README to a different file. |
The convention I used was that PRs can have multiple commits, but when it's merged in github -- the merge button has an option to squash its commits. I think that approach is preferred because keeping multiple commits in the PR makes it easier to review. |
Bobgy
force-pushed
the
update-1.0-readme
branch
2 times, most recently
from
1ed7ad2 to
a7103d5
Compare
Bobgy
changed the title
|
Hi @wlynch, I updated to target this as README of v1.1 release instead. |
Bobgy
force-pushed
the
update-1.0-readme
branch
from
a7103d5 to
c84fde2
Compare
| If you were using `go get` to install this tool, note that | ||
| [starting in Go 1.17, go get is deprecated for installing binaries](https://go.dev/doc/go-get-install-deprecation). |
There was a problem hiding this comment.
Note, required features for go install are usable starting from go 1.16, so we can simply tell people to use go install now.
Bobgy
force-pushed
the
update-1.0-readme
branch
from
c84fde2 to
a4b5f62
Compare
|
The doc addresses a lot of user confusions raised in previous issues. I'll merge and release v1.1 |
Fixes #103
Fixes #109