lbry.tech/README.md

51 lines
1.4 KiB
Markdown
Raw Normal View History

2018-08-31 21:24:41 +02:00
<h1 align="center">lbry.tech</h1>
2018-06-06 14:35:18 +02:00
2018-08-31 21:24:41 +02:00
<div align="center">
<strong>We came from the future to help you save the Internet</strong>
</div>
2018-08-31 21:24:41 +02:00
<div align="center">
2018-08-31 21:27:30 +02:00
Technical documentation website for <a href="https://lbry.io">the LBRY protocol</a>.
2018-08-31 21:24:41 +02:00
</div>
<div align="center">
2018-08-31 21:28:28 +02:00
<img src="https://cdn.rawgit.com/lbryio/lbry.tech/2a16aa55/preview.png" title="Screenshot of lbry.tech"/>
2018-08-31 21:24:41 +02:00
</div>
<div align="center">
2018-08-31 21:28:28 +02:00
<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>
2018-08-31 21:24:41 +02:00
</div>
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
## Prerequisites
- [lbry/web-daemon](https://github.com/lbryio/web-daemon)
- [Node](https://nodejs.org) (version >= 10)
2018-05-10 15:06:12 +02:00
## Installation
2018-08-31 21:29:28 +02:00
`npm i`
2018-05-10 15:06:12 +02:00
2018-07-12 17:21:42 +02:00
## Development
`npm run watch` and visit [localhost:8080](http://localhost:8080)
2018-05-10 15:06:12 +02:00
## Testing
`npm test`
2018-05-10 15:06:12 +02:00
## Production
`npm start`
2018-07-12 17:21:42 +02:00
## Usage
Visit [LBRY.tech](https://lbry.tech) to see this repo in production.
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.
## Contact
2018-08-07 00:51:32 +02:00
The primary contact for this project is [@netoperatorwibby](https://github.com/netoperatorwibby)(paul@lbry.io).