2018-07-12 17:21:42 +02:00
# LBRY.tech
Technical documentation website for [the LBRY protocol ](https://lbry.io ) made with JavaScript.
2018-03-23 12:53:54 +01:00
2018-07-12 23:30:26 +02:00
[](https://travis-ci.org/lbryio/lbry.tech)
2018-06-06 14:35:18 +02:00
2018-07-12 17:21:42 +02:00
2018-03-23 12:53:54 +01:00
2018-05-10 15:06:12 +02:00
Notable tools used:
2018-03-23 12:53:54 +01:00
2018-07-12 17:21:42 +02:00
* [choo ](https://choo.io )
2018-07-12 23:30:26 +02:00
* [Fastify ](https://www.fastify.io )
2018-03-23 12:53:54 +01:00
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
2018-05-10 15:06:12 +02:00
## Installation
2018-07-12 17:21:42 +02:00
[Node ](https://nodejs.org ) (version >= 10) is required, so install that first. Then fork this repo, `cd` into it and run `npm i` .
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
## Development
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
`npm run watch` and visit [localhost:8080 ](http://localhost:8080 )
2018-05-10 15:06:12 +02:00
2018-03-23 12:53:54 +01:00
2018-07-12 17:21:42 +02:00
## Usage
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
Visit [LBRY.tech ](https://lbry.tech ) to see this repo in production.
2018-03-23 12:53:54 +01:00
2018-05-10 15:06:12 +02:00
## Contributing
2018-07-12 17:21:42 +02:00
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md ](CONTRIBUTING.md ).
2018-05-10 15:06:12 +02:00
## License
2018-07-12 23:30:26 +02:00
This project is MIT licensed.
2018-07-12 17:21:42 +02:00
2018-05-10 15:06:12 +02:00
## Security
We take security seriously. Please contact [security@lbry.io ](mailto:security@lbry.io ) regarding any security issues. [Our PGP key is here ](https://keybase.io/lbry/key.asc ) if you need it.
2018-07-12 17:21:42 +02:00
2018-05-10 15:06:12 +02:00
## Contact
2018-07-12 23:07:16 +02:00
The primary contact for this project is [@netoperatorwibby ](https://github.com/netoperatorwibby ).
