spec/readme.md
2019-03-18 14:27:55 -04:00

39 lines
1.3 KiB
Markdown

# LBRY Protocol Specification
LBRY is a protocol for accessing and publishing digital content in a global, decentralized marketplace.
This repo contains the official protocol specification for LBRY. It is built with [Jekyll](https://jekyllrb.com/).
## Usage
The spec is available at https://spec.lbry.com.
To view the content locally, you must have [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and [bundler](https://bundler.io#getting-started) installed. Then run `bundle install` and `bundle exec jekyll serve`, and open `localhost:4000` in your browser.
## Contributing
To edit the spec:
- run `bundle exec jekyll serve --watch`
- make changes to the markdown
- refresh `localhost:4000` in your browser to see the effect of your changes.
Contributions to this project are welcome, encouraged, and compensated. For more details, [click here](https://lbry.com/faq/contributing).
## 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 security issues. [Our GPG key is here](https://lbry.com/faq/gpg-key) if you need it.
## Contact
The primary contact for this project is [@lyoshenka](https://github.com/lyoshenka) (grin@lbry.com).