From fde060a97bb00b8929276252c1dcebf8609dccfd Mon Sep 17 00:00:00 2001 From: Alex Grintsvayg Date: Tue, 29 May 2018 17:36:28 -0400 Subject: [PATCH] readme --- readme.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..16cd2b4 --- /dev/null +++ b/readme.md @@ -0,0 +1,40 @@ +# Reflector + +A reflector cluster to accept LBRY content for hosting en masse, rehost the content, and make money on data fees (TODO). +This code includes Go implementations of the LBRY peer protocol, reflector protocol, and DHT. + +## Installation + +coming soon + +## Usage + +coming soon + +## Running from Source + +This project requires [Go v1.10](https://golang.org/doc/install) or higher. + +``` +go get -u github.com/lbryio/reflector.go +cd "$(go env GOPATH)/src/github.com/lbryio/reflector.go" +make +./prism +``` + +## Contributing + +coming soon + +## License + +This project is MIT licensed. + +## Security + +We take security seriously. Please contact 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 [@lyoshenka](https://github.com/lyoshenka) (grin@lbry.io)