lbry-android/README.md

# LBRY Android
[![pipeline status](https://ci.lbry.tech/lbry/lbry-android/badges/master/pipeline.svg)](https://ci.lbry.tech/lbry/lbry-android/commits/master)
[![GitHub license](https://img.shields.io/github/license/lbryio/lbry-android)](https://github.com/lbryio/lbry-android/blob/master/LICENSE)

An Android browser and wallet for the [LBRY](https://lbry.com) network.


<img src="https://spee.ch/@lbry:3f/android-08-homepage.gif" alt="LBRY Android GIF" width="384px" />


## Installation
The minimum supported Android version is 5.0 Lollipop. There are two ways to install:

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.
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** from the device's app drawer or via the shortcut on the home screen if that was created upon installation.

## Running from Source
Clone the repository and open the project in Android Studio. Android Studio will automatically run the initial build process.

Create file 'twitter.properties' in app/ folder with the following content:

```
twitterConsumerKey=XXXXXX

twitterConsumerSecret=XXXXXX
```

Click the Sync button and when process finishes, the Run button to launch the app on your simulator or connected debugging device after the build process is complete.

## Contributing
Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing

## License
This project is MIT licensed. For the full license, see [LICENSE](LICENSE).

## Security
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
The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.com)
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`# LBRY Android`
add pipeline status to README.md 2019-03-30 10:24:20 +01:00			`[![pipeline status](https://ci.lbry.tech/lbry/lbry-android/badges/master/pipeline.svg)](https://ci.lbry.tech/lbry/lbry-android/commits/master)`
Added license and build badges 2019-10-12 21:11:09 +02:00			`[![GitHub license](https://img.shields.io/github/license/lbryio/lbry-android)](https://github.com/lbryio/lbry-android/blob/master/LICENSE)`
README formatting fix 2018-04-30 21:16:46 +02:00
update README 2020-06-19 07:57:48 +02:00			`An Android browser and wallet for the [LBRY](https://lbry.com) network.`
Initial commit 2017-08-13 03:24:00 +02:00
Added gif as requested Updated the old image with the gif from https://lbry.com/android as requested 2019-10-21 07:30:33 +02:00
			`<img src="https://spee.ch/@lbry:3f/android-08-homepage.gif" alt="LBRY Android GIF" width="384px" />`

added screenshot to README 2018-06-30 13:25:57 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Installation`
light README cleanup 2018-04-30 21:23:34 +02:00			`The minimum supported Android version is 5.0 Lollipop. There are two ways to install:`

updated readme for beta 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.`
light README cleanup 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.`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Usage`
update readme 2020-03-02 16:22:19 +01:00			`The app can be launched by opening LBRY from the device's app drawer or via the shortcut on the home screen if that was created upon installation.`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Running from Source`
Provide instructions to add dummy Twitter API credentials 2020-12-14 20:38:57 +01:00			`Clone the repository and open the project in Android Studio. Android Studio will automatically run the initial build process.`

			`Create file 'twitter.properties' in app/ folder with the following content:`

			```
			`twitterConsumerKey=XXXXXX`

			`twitterConsumerSecret=XXXXXX`
			```

			`Click the Sync button and when process finishes, the Run button to launch the app on your simulator or connected debugging device after the build process is complete.`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Contributing`
			`Contributions to this project are welcome, encouraged, and compensated. For more details, see https://lbry.io/faq/contributing`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## License`
			`This project is MIT licensed. For the full license, see [LICENSE](LICENSE).`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Security`
change io to com (#504) * Update README.md * Update issue_template.md 2019-04-05 16:54:56 +02:00			`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.`
Initial commit 2017-08-13 03:24:00 +02:00
standardised README.md. Created BUILD.md for full build instructions. 2018-04-28 01:36:03 +02:00			`## Contact`
change io to com (#504) * Update README.md * Update issue_template.md 2019-04-05 16:54:56 +02:00			`The primary contact for this project is [@akinwale](https://github.com/akinwale) (akinwale@lbry.com)`