lbry-sdk/README.md

53 lines
2.3 KiB
Markdown
Raw Normal View History

2016-05-23 04:45:08 +02:00
[![Build Status](https://travis-ci.org/lbryio/lbry.svg?branch=master)](https://travis-ci.org/lbryio/lbry)
2016-10-30 22:55:12 +01:00
[![Coverage Status](https://coveralls.io/repos/github/lbryio/lbry/badge.svg)](https://coveralls.io/github/lbryio/lbry)
2016-05-23 04:45:08 +02:00
# LBRY
2015-08-20 17:27:15 +02:00
2017-03-13 16:59:12 +01:00
LBRY is an open-source protocol providing distribution, discovery, and purchase of digital content (data) via a decentralized network.
2017-03-13 16:59:12 +01:00
This repo is a reference implementation of the [LBRY API](https://lbry.io/api).
2017-03-13 16:59:12 +01:00
It provides a daemon that can interact with the network via a json-rpc interface over HTTP.
2017-02-20 22:12:47 +01:00
2017-03-13 16:59:12 +01:00
## Installing
2015-08-20 17:27:15 +02:00
2017-07-05 22:30:35 +02:00
**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).
2017-02-20 22:12:47 +01:00
2017-06-02 09:44:25 +02:00
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.
2017-02-20 22:12:47 +01:00
2017-03-13 16:59:12 +01:00
Installing from source is also relatively painless, full instructions are in [INSTALL.md](INSTALL.md)
2017-02-20 22:12:47 +01:00
2017-03-13 17:05:13 +01:00
## Running
2016-05-23 22:13:46 +02:00
2017-03-13 17:05:13 +01:00
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.
2017-07-05 22:28:41 +02:00
Our [quickstart guide](http://lbry.io/quickstart) provides a simple walkthrough and examples for learning.
2017-03-13 17:05:13 +01:00
The full API is documented [here](https://lbryio.github.io/lbry/cli).
2016-05-23 22:13:46 +02:00
## What is LBRY?
2017-09-18 19:03:32 +02:00
LBRY is a protocol that provides a fully decentralized network for the discovery, distribution, and payment of data.
2017-03-13 17:14:02 +01:00
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.
2018-05-13 14:46:24 +02:00
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.
2017-02-20 22:12:47 +01:00
## Contributions
2015-08-20 17:27:15 +02:00
2017-10-31 15:36:21 +01:00
To contribute, [join us on Discord](https://chat.lbry.io/) or contact jeremy@lbry.io. Pull requests are also welcome.
2015-08-20 17:27:15 +02:00
## Support
2015-08-20 17:27:15 +02:00
2016-05-23 22:13:46 +02:00
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.
2015-08-20 17:27:15 +02:00
## License
2015-08-20 17:27:15 +02:00
2015-12-06 20:36:41 +01:00
See [LICENSE](LICENSE)