Skip to content

Commit 367e138

Browse files
committed
Use symbolic links for documentation
The inner crates now use the files from the root.
1 parent b96b868 commit 367e138

File tree

9 files changed

+48
-10
lines changed

9 files changed

+48
-10
lines changed

crates-io.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# iabgpp-rs
2+
3+
Rust implementation of the IAB Global Privacy Platform (GPP)
4+
[consent string specification](https://github.com/InteractiveAdvertisingBureau/Global-Privacy-Platform/blob/main/Core/Consent%20String%20Specification.md).
5+
6+
## Features
7+
8+
- Eager or lazy decoding of GPP sections
9+
- Owning type (GPPString)
10+
- Reference type (GPPStr)
11+
- Read support for all current GPP sections
12+
13+
## Usage example
14+
15+
Cargo.toml:
16+
17+
```toml
18+
[dependencies]
19+
iab-gpp = "0.1"
20+
```
21+
22+
main.rs:
23+
24+
```rust
25+
use std::error::Error;
26+
use std::str::FromStr;
27+
use iab_gpp::v1::GPPString;
28+
29+
fn main() {
30+
let s = "DBABM~CPXxRfAPXxRfAAfKABENB-CgAAAAAAAAAAYgAAAAAAAA";
31+
let gpp_str = GPPString::from_str(s).expect("a valid GPP string");
32+
33+
for &id in gpp_str.section_ids() {
34+
println!("Section id: {:?}", id);
35+
36+
let section = gpp_str.decode_section(id).expect("a valid section");
37+
println!("Section: {:?}", &section);
38+
}
39+
}
40+
```

iab_gpp/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ license = "Apache-2.0"
1010
keywords = ["tcf", "iab", "gpp", "decode"]
1111
categories = ["parser-implementations"]
1212
documentation = "https://docs.rs/iab_gpp/"
13-
readme = "README.md"
13+
readme = "crates-io.md"
1414

1515
[dependencies]
1616
bitstream-io = "2.5.3"

iab_gpp/LICENSE

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE

iab_gpp/README.md

-3
This file was deleted.

iab_gpp/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

iab_gpp/crates-io.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../crates-io.md

iab_gpp_derive/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ license = "Apache-2.0"
1010
keywords = ["tcf", "iab", "gpp", "decode"]
1111
categories = ["parser-implementations"]
1212
documentation = "https://docs.rs/iab_gpp/"
13-
readme = "README.md"
13+
readme = "crates-io.md"
1414

1515
[dependencies]
1616
proc-macro2 = "1.0.86"

iab_gpp_derive/LICENSE

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../LICENSE

iab_gpp_derive/README.md

-5
This file was deleted.

iab_gpp_derive/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../README.md

iab_gpp_derive/crates-io.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../crates-io.md

0 commit comments

Comments
 (0)