Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 252b57e

Browse files
authoredMay 1, 2024
Reformat Readme.md to conform with C#SDK readme (#38)
1 parent 7f7b45d commit 252b57e

File tree

1 file changed

+22
-40
lines changed

1 file changed

+22
-40
lines changed
 

‎README.md

Lines changed: 22 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,11 @@
33
The UID 2 Project is subject to Tech Lab IPR’s Policy and is managed by the IAB Tech Lab Addressability Working Group and Privacy & Rearc Commit Group. Please review [the governance rules](https://github.com/IABTechLab/uid2-core/blob/master/Software%20Development%20and%20Release%20Procedures.md).
44

55
This document includes:
6-
* [Who Is this SDK for?](#who-is-this-sdk-for)
76
* [Requirements](#requirements)
87
* [Install](#install)
9-
* [Usage for DSPs](#usage-for-dsps)
10-
* [Usage for Publishers](#usage-for-publishers)
11-
* [Standard Integration](#standard-integration)
12-
* [Server-Only Integration](#server-only-integration)
13-
* [Usage for UID2 Sharers](#usage-for-uid2-sharers)
8+
* [Usage](#usage)
149
* [Development](#development)
15-
* [Example Usage](#example-usage)
16-
* [History](#history)
17-
18-
## Who Is this SDK for?
19-
20-
This SDK simplifies integration with UID2 for Publishers, DSPs and UID Sharers, as described in [UID2 Integration Guides](https://unifiedid.com/docs/category/integration-guides).
10+
* [Example Usage](#example-usage)
2111

2212
## Requirements
2313

@@ -34,6 +24,26 @@ pip install uid2-client
3424

3525
For documentation on usage, see the [UID2 SDK for Python Reference Guide](https://unifiedid.com/docs/sdks/uid2-sdk-ref-python).
3626

27+
## Example Usage
28+
29+
To run all the example applications:
30+
31+
```
32+
make examples BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
33+
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A== \
34+
RAW_UID=JCqmlLXpbbu/jTdpB2a1cNAVs8O72eMXPaQzC9Ic9mE= \
35+
DOMAIN=example.com
36+
```
37+
38+
Alternatively, you can run specific examples:
39+
40+
```
41+
make example_client BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
42+
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
43+
make example_auto_refresh BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
44+
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
45+
```
46+
3747
## Development
3848

3949
First, build the Docker image with Python 3.6 and all dev dependencies. This is required for all subsequent commands. Run the following:
@@ -59,31 +69,3 @@ Get access to an interactive shell within the Python 3.6 Docker image:
5969
```
6070
make shell
6171
```
62-
63-
### Example Usage
64-
65-
To run all the example applications:
66-
67-
```
68-
make examples BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
69-
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A== \
70-
RAW_UID=JCqmlLXpbbu/jTdpB2a1cNAVs8O72eMXPaQzC9Ic9mE= \
71-
DOMAIN=example.com
72-
```
73-
74-
Alternatively, you can run specific examples:
75-
76-
```
77-
make example_client BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
78-
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
79-
make example_auto_refresh BASE_URL=https://prod.uidapi.com AUTH_KEY=my-auth-key SECRET_KEY=my-secret-key \
80-
AD_TOKEN=AgAAAANRdREk+IWqqnQkZ2rZdK0TgSUP/owLryysSkUGZJT+Gy551L1WJMAZA/G2B1UMDQ20WAqwwTu6o9TexWyux0lg0HHIbmJjN6IYwo+42KC8ugaR+PX0y18qQ+3yzkxmJ/ee//4IGu/1Yq4AmO4ArXN6CeszPTxByTkysVqyQVNY2A==
81-
```
82-
83-
## History
84-
85-
### 2.2.0 (07/26/2023)
86-
* Added support for /token/generate
87-
* Added support for /token/refresh
88-
### 2.2.1 (12/05/2023)
89-
* Support for policy=0 will be removed soon

0 commit comments

Comments
 (0)
Please sign in to comment.