Skip to content
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

Jump to bottom

README.md: remove note about proof-of-concept #13

Merged
merged 1 commit into from
Feb 25, 2022
Merged

README.md: remove note about proof-of-concept #13

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 5 additions & 8 deletions README.md
View file
Open in desktop
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