From 14efa9438253edbe87439f46d7f256c8f66ab3a6 Mon Sep 17 00:00:00 2001 From: hackrush Date: Mon, 18 Jun 2018 14:56:07 -0400 Subject: [PATCH] Started to standardize the README.md file. Closes #1252 --- INSTALL.md | 1 + README.md | 55 +++++++++++++++++++++++++++--------------------------- 2 files changed, 29 insertions(+), 27 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 06a090dd1..a12974f5c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -80,6 +80,7 @@ To install: python --version # Python 3 is not supported. Make sure you're on Python 2.7 pip install -U -r requirements.txt + pip install -U -r requirements_testing.txt pip install --editable . ``` diff --git a/README.md b/README.md index abdc28049..2813a7fc7 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,53 @@ +# LBRY + [![Build Status](https://travis-ci.org/lbryio/lbry.svg?branch=master)](https://travis-ci.org/lbryio/lbry) [![Coverage Status](https://coveralls.io/repos/github/lbryio/lbry/badge.svg)](https://coveralls.io/github/lbryio/lbry) -# LBRY +LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized network. It utilizes the [LBRY blockchain](https://github.com/lbryio/lbrycrd) as a global namespace and database of digital content. Blockchain entries contain searchable content metadata, identities, and rights and access rules. LBRY also provides a data network that consists of peers uploading and downloading data from other peers, possibly in exchange for payments, and a distributed hash table, used by peers to discover other peers. -LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized network. +This project aims to provide a daemon that can interact with the network via a json-rpc interface over HTTP. -This repo is a reference implementation of the [LBRY API](https://lbry.io/api). +The project is written in python2.7 and extensively uses Twisted framework. -It provides a daemon that can interact with the network via a json-rpc interface over HTTP. +## Installation -## Installing - -**Note**: This project no longer bundles a graphic interface (browser). If you want to use LBRY via a GUI, [use the LBRY App](https://github.com/lbryio/lbry-app). +| | Windows | macOS | Linux | +| --------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | +| Latest Stable Release | [Download](https://github.com/lbryio/lbry/releases/download/v0.20.0/lbrynet-daemon-v0.20.0-windows.zip) | [Download](https://github.com/lbryio/lbry/releases/download/v0.20.0/lbrynet-daemon-v0.20.0-macos.zip) | [Download](https://github.com/lbryio/lbry/releases/download/v0.20.0/lbrynet-daemon-v0.20.0-linux.zip) | +| Latest Pre-release | [Download](https://github.com/lbryio/lbry/releases/download/untagged-99114fa31abbfe3a5ef4/lbrynet-daemon-v0.20.1rc3-windows.zip) | [Download](https://github.com/lbryio/lbry/releases/download/untagged-99114fa31abbfe3a5ef4/lbrynet-daemon-v0.20.1rc3-macos.zip) | [Download](https://github.com/lbryio/lbry/releases/download/v0.20.1rc4/lbrynet-daemon-v0.20.1rc4-linux.zip) | Our [releases page](https://github.com/lbryio/lbry/releases) contains pre-built binaries of the latest release, pre-releases, and past releases, for macOS, Debian-based Linux, and Windows. -Installing from source is also relatively painless, full instructions are in [INSTALL.md](INSTALL.md) - -## Running +## Usage Run `lbrynet-daemon` to launch the daemon. -## Using - By default, `lbrynet-daemon` will provide a JSON-RPC server at `http://localhost:5279`. It is easy to interact with via cURL or sane programming languages. Our [quickstart guide](http://lbry.io/quickstart) provides a simple walkthrough and examples for learning. The full API is documented [here](https://lbryio.github.io/lbry/cli). -## What is LBRY? +## Running from source -LBRY is a protocol that provides a fully decentralized network for the discovery, distribution, and payment of data. +Installing from source is also relatively painless, full instructions are in [INSTALL.md](INSTALL.md) -It utilizes the [LBRY blockchain](https://github.com/lbryio/lbrycrd) as a global namespace and database of digital content. Blockchain entries contain searchable content metadata, identities, and rights and access rules. +## Contributing -LBRY also provides a data network that consists of peers uploading and downloading data from other peers, possibly in exchange for payments, and a distributed hash table, used by peers to discover other peers. - -## Contributions - -To contribute, [join us on Discord](https://chat.lbry.io/) or contact jeremy@lbry.io. Pull requests are also welcome. - -## Support - -Please open an issue and describe your situation in detail. We will respond as soon as we can. - -For private issues, contact jeremy@lbry.io. +Contributions to this project are welcome, encouraged, and compensated. For more details, please check [this](https://lbry.io/faq/contributing) link. ## License -See [LICENSE](LICENSE) +This project is MIT licensed. For the full license, see [LICENSE](LICENSE). + +## Security + +We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is here if you need it. + +## Contact + +The primary contact for this project is @jackrobison(jack@lbry.io) + +## Additional information and links + +The documentation for the api can be found [here](https://lbry.io/api). \ No newline at end of file