Skip to content

Commit

Permalink
Make readme.md structure more consistent with C# SDK
Browse files Browse the repository at this point in the history
  • Loading branch information
sunnywu committed May 1, 2024
1 parent da150f5 commit 517f044
Showing 1 changed file with 13 additions and 17 deletions.
30 changes: 13 additions & 17 deletions README.md
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

UID2 is released under the Apache license. [See LICENSE](https://github.com/IABTechLab/uid2-android-sdk/blob/main/LICENSE.md) for details.
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.

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`.

0 comments on commit 517f044

Please sign in to comment.