lbry.tech/README.md
ポール ウェッブ 8b41dd8d8e README fix
2019-01-08 10:59:36 -06:00

64 lines
2 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://spee.ch/f2c2c29f7e6a76d84b341c5f42a832db7589b410/dottech-2018-october.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>
<a href="https://snyk.io/test/github/lbryio/lbry.tech">
<img src="https://snyk.io/test/github/lbryio/lbry.tech/badge.svg?style=flat-square"/>
</a>
</div>
## Prerequisites
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
- [Node](https://nodejs.org) (version >= 10)
## Notes
- **This repo will not run locally if you do not also have the LBRY app/daemon and the [web-daemon](https://github.com/lbryio/web-daemon) running.**
- When running locally and completing the tipping example in Playground, the LBC donated to a creator comes from _your_ LBC balance. Otherwise, the example will fail. On production, the donated LBC comes from LBRY.
## 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. For the full license, see [LICENSE](LICENSE).
## 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).