lbry.go/readme.md
2022-01-17 09:40:58 -05:00

43 lines
1.6 KiB
Markdown

# The LBRY Protocol in Go
lbry.go is a set of tools and projects implemented in Golang. See each subfolder for more details
**there are significant updates in the [v3 branch](https://github.com/lbryio/lbry.go/tree/v3). if you're starting a new project, strongly consider using that version instead**
[![Build Status](https://travis-ci.org/lbryio/lbry.go.svg?branch=master)](https://travis-ci.org/lbryio/lbry.go)
This project uses Go modules. Make sure you have Go 1.11+ installed.
- Ubuntu: https://launchpad.net/~longsleep/+archive/ubuntu/golang-backports or https://github.com/golang/go/wiki/Ubuntu
- OSX: `brew install go`
### Building
- clone the repository
- run `make` from the root directory to build the binary
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see [lbry.com/faq/contributing](https://lbry.com/faq/contributing)
Make sure you `go fmt` your code before submitting PRs.
## Versioning
This codebase follows the semver standards. You can find the releases [here](https://github.com/lbryio/lbry.go/releases)
You can include the libraries by running `go get github.com/lbryio/lbry.go@latest`.
You can lock (and you should) to a version whenever you make use of this set of libraries.
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security
We take security seriously. Please contact security@lbry.com regarding any issues you may encounter.
Our PGP key is [here](https://lbry.com/faq/pgp-key) if you need it.
## Contact
The primary contact for this project is [@lyoshenka](https://github.com/lyoshenka) (grin@lbry.com)