search

google / go-licenses

A lightweight tool to report on the licenses used by a Go package and its dependencies. Highlight! Versioned external URL to licenses can be found at the same time.
Apache License 2.0
833 stars 125 forks source link

doc: update usages for v1.1 #111

Closed Bobgy closed 2 years ago

Bobgy commented 2 years ago

Fixes https://github.com/google/go-licenses/issues/103 Fixes https://github.com/google/go-licenses/issues/109

Bobgy commented 2 years ago

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.

Bobgy commented 2 years ago

LGTM! I've been bad about staying on top of this for other PRs, but please squash before submission 🙏

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 commented 2 years ago

Hi @wlynch, I updated to target this as README of v1.1 release instead.

Bobgy commented 2 years ago

The doc addresses a lot of user confusions raised in previous issues. I'll merge and release v1.1