spec/readme.md

39 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

2018-12-25 21:20:18 +01:00
# 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
2021-05-04 00:06:39 +02:00
The spec is available at https://spec.lbry.com.
2018-12-25 21:20:18 +01:00
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
2018-12-25 21:20:18 +01:00
- refresh `localhost:4000` in your browser to see the effect of your changes.
2019-03-18 19:27:55 +01:00
Contributions to this project are welcome, encouraged, and compensated. For more details, [click here](https://lbry.com/faq/contributing).
2018-12-25 21:20:18 +01:00
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security
2021-05-04 00:06:39 +02:00
We take security seriously. Please contact security@lbry.com regarding any security issues. [Our PGP key is here](https://lbry.com/faq/pgp-key) if you need it.
2018-12-25 21:20:18 +01:00
## Contact
2019-03-18 19:27:55 +01:00
The primary contact for this project is [@lyoshenka](https://github.com/lyoshenka) (grin@lbry.com).