Skip to content

docs(oss-licenses): trim README to avoid duplication with public docs #411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timothyfroehlich merged 3 commits into from
Apr 23, 2026
+4 −58
Merged

docs(oss-licenses): trim README to avoid duplication with public docs #411

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ad013bf
docs(oss-licenses): trim README to avoid duplication with public docs
timothyfroehlich Apr 22, 2026
207f284
Merge branch 'main' into froeht/trim-readme
timothyfroehlich Apr 23, 2026
ba718dc
restore how it works section
timothyfroehlich Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 4 additions & 58 deletions oss-licenses-plugin/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,64 +18,10 @@ The plugin will generate two text files based on the gathered licenses info:
and registers them as raw resources so that it can be consumed by the
play-services-oss-licenses library.

## To Use
For detailed instructions on how to add the plugin to your project, configure dependencies, and display license information using the SDK, please refer to the official documentation:

### Add the Gradle plugin
👉 **[Include open source notices](https://developers.google.com/android/guides/opensource)**

In your root-level `settings.gradle.kts` make sure you are using the
[Google Maven repository](https://developer.android.com/studio/build/dependencies#google-maven):
## Source Code and Contributing

```kotlin
pluginManagement {
repositories {
google()
}
}
```

In your app-level `build.gradle.kts`, apply the plugin by adding the following line
under the existing `id("com.android.application")` at the top of the
file:

```kotlin
plugins {
id("com.google.android.gms.oss-licenses-plugin") version "0.11.0"
}
```

### Add the library to your app

In the `dependencies` section of your app-level `build.gradle.kts`, add a dependency
on the `oss-licenses` library:

```kotlin
implementation("com.google.android.gms:play-services-oss-licenses:17.0.0")
```

### Displaying license information

When the application builds, the Gradle plugin will process the licenses and
add them to the app resources. To easily display them you can trigger an
activity provided by the `play-services-oss-licenses` library at an appropriate
point in your app:

```java
import com.google.android.gms.oss.licenses.OssLicensesMenuActivity;

// ...

// When the user selects an option to see the licenses:
startActivity(new Intent(this, OssLicensesMenuActivity.class));
```

This will display a list of open source libraries that are compiled into the
app, whether part of Google Play services or not. Tapping the library name will
display additional license information for that library.

### Setting the `Activity` title

You can also set the title of the displayed activity:

```java
OssLicensesMenuActivity.setActivityTitle(getString(R.string.custom_license_title));
```
The source code for this plugin is hosted in this repository. For contributing guidelines or to report issues, please see the root project documentation.
Loading