44 lines
1.3 KiB
Markdown
Executable file
44 lines
1.3 KiB
Markdown
Executable file
# LBRY.tech
|
|
Technical documentation website for [the LBRY protocol](https://lbry.io).
|
|
[](https://travis-ci.org/lbryio/lbry.tech)
|
|
|
|
Notable tools used:
|
|
* [choo](https://choo.io)
|
|
* [Fastify](https://www.fastify.io)
|
|
|
|
|
|
|
|
|
|
|
|
## Notes
|
|
- Requires our private `web-daemon` to be running locally, in development.
|
|
|
|
## Prerequisites
|
|
- [Node](https://nodejs.org) (version >= 10)
|
|
|
|
## Installation
|
|
`npm i`.
|
|
|
|
## Development
|
|
`npm run watch` and visit [localhost:8080](http://localhost:8080)
|
|
|
|
## Testing
|
|
`npm test`
|
|
|
|
## Production
|
|
`npm start`
|
|
|
|
## Usage
|
|
Visit [LBRY.tech](https://lbry.tech) to see this repo in production.
|
|
|
|
## Contributing
|
|
Contributions to this project are welcome, encouraged, and compensated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
|
|
|
|
## License
|
|
This project is MIT licensed.
|
|
|
|
## 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.
|
|
|
|
## Contact
|
|
The primary contact for this project is [@netoperatorwibby](https://github.com/netoperatorwibby)(paul@lbry.io).
|