LBRYCommunity/lbry-desktop
1
0
Fork 0
Code Issues 596 Pull requests 6 Projects Releases 238 Packages Wiki Activity

Update README.md

Browse source 
Added  Table of contents
This commit is contained in:
Amal Jose 2019-10-07 09:27:37 +05:30 committed by Sean Yesmunt
parent 6b0f791144
commit 8de33242ea
1 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -15,7 +15,21 @@ The LBRY app is a graphical browser for the decentralized content marketplace pr
![App GIF](https://spee.ch/@lbry:3f/darwin-029.gif)
## Install
## Table of Contents
1. [Install](#install)
2. [Usage](#usage)
3. [Running from Source](#running-from-source)
4. [Contributing](#contributing)
5. [License](#license)
6. [Security](#security)
7. [Contact](#contact)
<h2 align="left">Install</h2>
We provide installers for Windows, macOS (v10.12.4, Sierra, or greater), and Debian-based Linux. See community maintained builds section for alternative Linux installations.
@ -38,11 +52,11 @@ _Note: If coming from a deb install, the directory structure is different and yo
| Latest Release | [FlatHub Page](https://flathub.org/apps/details/io.lbry.lbry-app) | [AUR Package](https://aur.archlinux.org/packages/lbry-app-bin/) | [Pi Installer](https://lbrypi.com) |
| Maintainers | [@choofee](https://github.com/choffee)/[@iuyte](https://github.com/iuyte) | [@kcseb](https://github.com/kcseb)/[@TimurKiyivinski](https://github.com/TimurKiyivinski) | [@Madiator2011](https://github.com/kodxana) |
## Usage
<h2 align="left">Usage</h2>
Double click the installed application to interact with the LBRY network.
## Running from Source
<h2 align="left">Running from Source</h2>
You can run the web version (beta.lbry.tv), the electron app, or both at the same time.
@ -85,20 +99,20 @@ If the app isn't building, or `yarn xxx` commands aren't working you may need to
If you _really_ think something might have gone wrong, you can force your repo to clear everything that doesn't match the repo with `git reset --hard HEAD && git clean -fxd && git pull -r`
## Contributing
<h2 align="left">Contributing</h2>
We :heart: contributions from everyone and contributions to this project are encouraged, and compensated. We welcome [bug reports](https://github.com/lbryio/lbry-desktop/issues/), [bug fixes](https://github.com/lbryio/lbry-desktop/pulls) and feedback is always appreciated. For more details, see [CONTRIBUTING.md](CONTRIBUTING.md).
## [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/lbryio/lbry-desktop/issues) [![GitHub contributors](https://img.shields.io/github/contributors/lbryio/lbry-desktop.svg)](https://GitHub.com/lbryio/lbry-desktop/graphs/contributors/)
## License
<h2 align="left">License</h2>
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
## Security
<h2 align="left">Security</h2>
We take security seriously. Please contact security@lbry.com regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
## Contact
<h2 align="left">Contact</h2>
The primary contact for this project is [@seanyesmunt](https://github.com/seanyesmunt).