lbry-android-sdk/README.md

31 lines
1.9 KiB
Markdown
Raw Normal View History

# LBRY Android
[![Build Status](https://travis-ci.org/lbryio/lbry-android.svg?branch=master)](https://travis-ci.org/lbryio/lbry-android)
2018-04-30 21:16:46 +02:00
2018-04-30 21:23:34 +02:00
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.
2017-08-13 03:24:00 +02:00
2018-06-30 13:30:48 +02:00
<img src="https://spee.ch/8/lbry-android.png" alt="LBRY Android Screenshot" width="384px" />
2018-06-30 13:25:57 +02:00
## Installation
2018-04-30 21:23:34 +02:00
The minimum supported Android version is 5.0 Lollipop. There are two ways to install:
2018-09-24 14:30:06 +02:00
1. Via the Google Play Store. Anyone can join the [open beta](https://play.google.com/apps/testing/io.lbry.browser) in order to install the app from the Play Store.
2018-04-30 21:23:34 +02:00
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.
2017-08-13 03:24:00 +02:00
## Usage
2018-10-29 20:56:35 +01:00
The app can be launched by opening **LBRY Browser** from the device's app drawer or via the shortcut on the home screen if that was created upon installation.
2017-08-13 03:24:00 +02:00
## Running from Source
2018-04-30 21:25:08 +02:00
The app is built from source via [Buildozer](https://github.com/kivy/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.
2017-08-13 03:24:00 +02:00
## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing
2017-08-13 03:24:00 +02:00
## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).
2017-08-13 03:24:00 +02:00
## Security
We take security seriously. Please contact security@lbry.io regarding any security issues. Our PGP key is [here](https://keybase.io/lbry/key.asc) if you need it.
2017-08-13 03:24:00 +02:00
## Contact
The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.io)