Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dvaumoron committed Mar 25, 2024
1 parent e84ac18 commit c08e798
Showing 1 changed file with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,41 @@
# gosince

gosince shows the introducing version of a go package or symbol, then display go doc information about it.
gosince shows the introducing version of a go package or symbol, has a flag to call `go doc` about it.

## Getting started

Install via [Homebrew](https://brew.sh/)

```console
$ brew tap dvaumoron/tap
$ brew install gosince
```

Or get the [last binary](https://github.com/dvaumoron/gosince/releases) depending on your OS.

```console
$ gosince SliceHeader
found reflect SliceHeader added in go1 and deprecated in go1.21
```

```console
$ gosince -h
gosince shows the introducing version of a go package or symbol, find more details at : https://github.com/dvaumoron/gosince

Usage of gosince:
gosince <pkg>
gosince <sym>
gosince <pkg>.<sym>[.<methodOrField>]
gosince <pkg> <sym>[.<methodOrField>]

Usage:
gosince expr1 [expr2] [flags]

Flags:
-p, --cache-path string Local path to cache the retrieved api information (default "/home/dvaumoron/.gosince")
-d, --go-doc Call go doc command
-h, --help help for gosince
-a, --source-addr string Location of Go source (default "https://raw.githubusercontent.com/golang/go/master")
-v, --verbose Verbose output
--version version for gosince
```

0 comments on commit c08e798

Please sign in to comment.