light README cleanup

This commit is contained in:
Jeremy Kauffman 2018-04-30 15:23:34 -04:00 committed by GitHub
parent 4960b9e2ec
commit 296f8b2363
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,16 +1,19 @@
# LBRY Android
[![Build Status](https://travis-ci.org/lbryio/lbry-android.svg?branch=master)](https://travis-ci.org/lbryio/lbry-android)
The LBRY Android app running the Python lbrynet-daemon as a background service and a UI layer built with React Native. The APK is built using buildozer and the Gradle build tool.
An Android browser and wallet for the [LBRY](https://lbry.io) network. This app bundles [lbrynet-daemon](https://github.com/lbryio/lbry) as a background service with a UI layer built with React Native. The APK is built using buildozer and the Gradle build tool.
## Installation
The minimum supported Android version is 5.0 Lollipop. There are currently 2 options for obtaining the APK. The latest APK release can be downloaded from http://build.lbry.io/android/latest.apk. You will need to enable installation from third-party sources on your device in order to install from this source. The other option is to install from the Google Play Store.
The minimum supported Android version is 5.0 Lollipop. There are two ways to install:
1. Via the Google Play Store. While in alpha, you will see it in the Play Store if you sign up [here](https://lbry.io/android-alpha).
1. Direct APK install available at [http://build.lbry.io/android/latest.apk](http://build.lbry.io/android/latest.apk). You will need to enable installation from third-party sources on your device in order to install from this source.
## Usage
The app can be launched by opening **LBRY Browser** from the device's app drawer or a shortcut on the homescreen if that was created upon install.
The app can be launched by opening **LBRY Browser** from the device's app drawer or via the shortcut on the homescreen if that was created upon install.
## Running from Source
The app can be built from source using `buildozer`. The first thing you will need to do after cloning the repository is create a `buildozer.spec` file. You can base your spec on the provided sample file `buildozer.spec.sample`. Please read [BUILD.md](BUILD.md) for detailed build instructions.
The app is built from source via `buildozer`. After cloning the repository, copy `buildozer.spec.sample` to `buildozer.spec` and modify this file as necessary for your environment. Please see [BUILD.md](BUILD.md) for detailed build instructions.
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing