1 AboutOss

     2 ==========

     3 

     4 AboutOss is an utility library to retrieve and display opensource licenses in Android applications.

     5 

     6 Usage

     7 =====

     8 

     9 The library works with the [OSS Licenses Gradle Plugin](https://github.com/google/play-services-plugins/tree/master/oss-licenses-plugin). 

    10 You can integrate it in your application with few simple steps.

    11 

    12 ### Apply the OSS Licenses Gradle Plugin

    13 

    14 In your app-level `build.gradle`, apply the plugin by adding the following line under the existing `apply plugin: 'com.android.application'` at the top of the file:

    15 

    16 ```build.gradle.kts

    17 apply plugin: 'com.google.android.gms.oss-licenses-plugin'

    18 ```

    19 

    20 ### Add the ui library to your application

    21 

    22 ```build.gradle.kts

    23 repositories {

    24     maven {

    25         url = uri("https://jitpack.io")

    26     }

    27 }

    28 

    29 dependencies {

    30     implementation("com.geekorum.aboutoss:ui-material:0.0.1")

    31 }

    32 ```

    33 

    34 ### Launch the license activity

    35 

    36 ```

    37 val intent = Intent(this, OpenSourceLicensesActivity::class.java)

    38 startActivity(intent)

    39 ```

    40 

    41 Build instructions

    42 ==================

    43 

    44 Just use Gradle to build

    45 

    46     ./gradlew build

    47 

    48 

    49 License

    50 =======

    51 

    52 AboutOss is an open source library and is licensed under the GNU General Public License 3 and any later version.

    53 This means that you can get AboutOss's code and modify it to suit your needs, as long as you publish the changes

    54 you make for everyone to benefit from as well.

    55 

    56 AboutOss is built and maintained by community volunteers.