Skip to content
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

Make readme.md structure more consistent with C# SDK #73

Merged
merged 2 commits into from
May 1, 2024
Merged

Make readme.md structure more consistent with C# SDK #73

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a10b40
Make readme.md structure more consistent with C# SDK
sunnywu May 1, 2024
2532b19
fix spelling
sunnywu May 1, 2024
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
30 changes: 13 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
# UID2 Android SDK
# UID2 SDK for Android

A framework for integrating [UID2](https://github.com/IABTechLab/uid2docs) into Android applications.
The UID 2 Project is subject to the IAB Tech Lab Intellectual Property Rights (IPR) Policy, and is managed by the IAB Tech Lab Addressability Working Group and [Privacy & Rearc Commit Group](https://iabtechlab.com/working-groups/privacy-rearc-commit-group/). Please review the [governance rules](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md).


[![License: Apache](https://img.shields.io/badge/License-Apache-green.svg)](https://www.apache.org/licenses/)

## Integration Guides

For the latest instructions on how to use the SDK and plugins in this repository, refer to the following:

| Component | Guide |
|------------------|--------------------------------------------------------------------------------------------------------------|
| UID2 Android SDK | [UID2 SDK for Android Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-android) |
| UID2 Google Mobile Ads (GMA) Plugin | [UID2 GMA Plugin for Android Integration Guide](https://unifiedid.com/docs/guides/mobile-plugin-gma-android) |
| UID2 Interactive Media Ads (IMA) Plugin | [UID2 IMA Plugin for Android Integration Guide](https://unifiedid.com/docs/guides/mobile-plugin-ima-android) |

## Repository Structure

```
Expand Down Expand Up @@ -42,11 +32,15 @@ For the latest instructions on how to use the SDK and plugins in this repository
|----------|-----------------------------------------------|
| Android | 4.4+ / API 19+ (SDK) 5.0+ / API 21+ (Dev-App) |

## Development
## Install and Usage

The UID2 SDK is a standalone headless library defined and published via Maven Central. As such the `dev-app` is the primary way for developing the SDK. Use Android Studio to open the root folder to begin development.
For the latest instructions on how to use the SDK and plugins in this repository, refer to the following:

ode style is enforced via the [Spotless Gradle plugin](https://github.com/diffplug/spotless) (using [ktlint](https://pinterest.github.io/ktlint/)). You can fix any formatting issues by running `./gradlew spotlessApply`.
| Component | Guide |
|------------------|--------------------------------------------------------------------------------------------------------------|
| UID2 Android SDK | [UID2 SDK for Android Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-android) |
| UID2 Google Mobile Ads (GMA) Plugin | [UID2 GMA Plugin for Android Integration Guide](https://unifiedid.com/docs/guides/mobile-plugin-gma-android) |
| UID2 Interactive Media Ads (IMA) Plugin | [UID2 IMA Plugin for Android Integration Guide](https://unifiedid.com/docs/guides/mobile-plugin-ima-android) |

R8 / ProGuard
-------------
Expand All @@ -55,6 +49,8 @@ If you are using R8 the shrinking and obfuscation rules are included automatical
ProGuard users must manually add the options from
[uid2-gma.pro](https://github.com/IABTechLab/uid2-android-sdk/blob/main/securesignals-gma/uid2-gma.pro) and [uid2-ima.pro](https://github.com/IABTechLab/uid2-android-sdk/blob/main/securesignals-ima/uid2-ima.pro).

## License
## Development

The UID2 SDK is a standalone headless library defined and published via Maven Central. As such the `dev-app` is the primary way for developing the SDK. Use Android Studio to open the root folder to begin development.

UID2 is released under the Apache license. [See LICENSE](https://github.com/IABTechLab/uid2-android-sdk/blob/main/LICENSE.md) for details.
Code style is enforced via the [Spotless Gradle plugin](https://github.com/diffplug/spotless) (using [ktlint](https://pinterest.github.io/ktlint/)). You can fix any formatting issues by running `./gradlew spotlessApply`.
Loading