Skip to content

Commit

Permalink
README.md: remove note about proof-of-concept (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
joelanford committed Feb 25, 2022
1 parent 31b0a32 commit 34d5209
Showing 1 changed file with 5 additions and 8 deletions.
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 34d5209

Please sign in to comment.