Skip to content

Commit

Permalink
Update README with go package link
Browse files Browse the repository at this point in the history
  • Loading branch information
dcorey-qualtrics committed Aug 2, 2024
1 parent fd40799 commit 08e6c44
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Hadoop Snappy Reader
[![Go Reference](https://pkg.go.dev/badge/github.com/qualtrics/hadoop-snappy.svg)](https://pkg.go.dev/github.com/qualtrics/hadoop-snappy)

Small library that provides a reader for reading Hadoop Snappy encoded data. See the Go Package documentation for more information on the format and how to use the reader.
Small library that provides a reader for reading Hadoop Snappy encoded data. See the (Go Package documentation)[https://pkg.go.dev/github.com/qualtrics/hadoop-snappy] for more information and examples of how to use the reader.

There are not currently plans to implement a writer, as the main utility of this library is to read and use data already produced by the Hadoop ecosystem. However, we are open to extending this library to support a writer or other use cases if there is interest.

Expand All @@ -23,7 +23,9 @@ go test ./...
1. Create the compressed file with `snzip -t hadoop-snappy -k testfile/{uncompressed file}`

## Release
Be sure to understand how [Go Module publishing](https://go.dev/blog/publishing-go-modules) works, especially semantic versioning. To release simply create a new semantically versioned tag and push it.
Be sure to understand how [Go Module publishing](https://go.dev/blog/publishing-go-modules) works, especially semantic versioning.

To release simply create a new semantically versioned tag and push it.
```bash
# Create a new semantic versioned tag with release notes
git tag -a v1.0.0 -m "release notes"
Expand Down

0 comments on commit 08e6c44

Please sign in to comment.