lbry.tech/README.md
2018-09-24 18:05:53 -05:00

50 lines
1.4 KiB
Markdown
Executable file

<h1 align="center">lbry.tech</h1>
<div align="center">
<strong>We came from the future to help you save the Internet</strong>
</div>
<div align="center">
Technical documentation website for <a href="https://lbry.io">the LBRY protocol</a>.
</div>
<div align="center">
<img src="https://cdn.rawgit.com/lbryio/lbry.tech/2a16aa55/preview.png" title="Screenshot of lbry.tech"/>
</div>
<div align="center">
<a href="https://travis-ci.org/lbryio/lbry.tech"><img src="https://img.shields.io/travis/lbryio/lbry.tech/master.svg?style=flat-square"/></a>
</div>
## Prerequisites
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
- [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).