Skip to content

Commit 7592fc7

Browse files
authored
Add godoc reference to README.md
1 parent c9c144e commit 7592fc7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,14 @@
11
# cockroachdb-parser
22

3+
[![Go Reference](https://pkg.go.dev/badge/github.com/cockroachdb/cockroachdb-parser.svg)](https://pkg.go.dev/github.com/cockroachdb/cockroachdb-parser)
4+
35
`cockroachdb-parser` is a snapshot of the parser package and
46
all its dependencies from the [CockroachDB repo][repo]. The
57
smaller package is Apache licensed and contains less dependencies
68
to pull in when configuring compared to `go get github.com/cockroachdb/cockroach`.
79

10+
A README of usage of the parser library can be found [here][parserreadme].
11+
812
The SHA this is based off is available in `version`.
913

1014
## Versioning
@@ -46,3 +50,4 @@ Ensure the [CockroachDB repo][repo] is cloned in your $GOPATH, and then type:
4650
```
4751

4852
[repo]: https://github.com/cockroachdb/cockroach
53+
[parserreadme]: pkg/sql/parser/README.md

0 commit comments

Comments
 (0)