From 34d520986b69218af5a5760c87dbefdfddd8b8bb Mon Sep 17 00:00:00 2001 From: Joe Lanford Date: Thu, 24 Feb 2022 23:04:30 -0500 Subject: [PATCH] README.md: remove note about proof-of-concept (#13) --- README.md | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index e962fa2..edb7a59 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,10 @@ # go-apidiff Check API compatibility between different revisions of a Go project -> **NOTE**: `go-apidiff` is an early proof-of-concept and has not been tested and -> verified on a wide variety of packages. Trust its results at your own risk. -> -> `go-apidiff` is dependent on Go's built-in package listing and type parsing, -> and can therefore be unreliable in certain situations. For example, if you're -> working outside of `$GOPATH` on a project that supports Go modules at the new -> commit, but not the old commit, you may not get accurate results. +`go-apidiff` is dependent on Go's built-in package listing and type parsing, +and can therefore be unreliable in certain situations. For example, if you're +working outside of `$GOPATH` on a project that supports Go modules at the new +commit, but not the old commit, you may not get accurate results. ## GitHub Action @@ -64,7 +61,7 @@ jobs: To install into $GOPATH/bin, run the following: ```console -$ go get github.com/joelanford/go-apidiff +$ go install github.com/joelanford/go-apidiff@latest ``` ## Usage