lbry-sdk/README.md
Lex Berezhny 0d8e55bc95
Remove icons directory (#1389)
* removed icons directory, saved 48x48.png icon to be the README.md icon
* removed extra whitespace in lbry.png
* point README to new icon
2018-08-24 17:36:52 -04:00

3.4 KiB

LBRY LBRY Build Status Test Coverage

LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized network. It utilizes the LBRY blockchain 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.

This project aims to provide a daemon that can interact with the network via a json-rpc interface over HTTP.

The project is written in Python 3.7+ and extensively uses Twisted framework.

Installation

Windows macOS Linux
Latest Stable Release Download Download Download
Latest Pre-release Download Download Download

Our releases page contains pre-built binaries of the latest release, pre-releases, and past releases, for macOS, Debian-based Linux, and Windows.

Usage

Run lbrynet start to launch the daemon.

By default, lbrynet 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 provides a simple walkthrough and examples for learning.

The full API is documented here.

Running from source

Installing from source is also relatively painless, full instructions are in INSTALL.md

Contributing

Contributions to this project are welcome, encouraged, and compensated. For more details, please check this link.

License

This project is MIT licensed. For the full license, see 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

The documentation for the api can be found here.