From 2562fc6b5b28f1bbb3b2a9d45007d185f7785b12 Mon Sep 17 00:00:00 2001 From: Rootul P Date: Wed, 10 Jan 2024 12:45:13 -0500 Subject: [PATCH] docs: README (#14) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f200223 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# go-square + +`go-square` is a Go library designed to provide utility functions for data square operations. + +## Installation + +To use `go-square` as a dependency in your Go project, you can use `go get`: + +```bash +go get github.com/celestiaorg/go-square +``` + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +This repo attempts to conform to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) so PR titles should ideally start with `fix:`, `feat:`, `build:`, `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, or `test:` because this helps with semantic versioning and changelog generation. It is especially important to include an `!` (e.g. `feat!:`) if the PR includes a breaking change. + +1. Install [Go](https://golang.org/doc/install) 1.21.5 +1. Fork this repo +1. Make your changes +1. Submit a pull request