Skip to content

Commit

Permalink
Prepare to release version 0.1.0 (#55)
Browse files Browse the repository at this point in the history
* Update version to 0.1.0

* Update README for initial release
  • Loading branch information
divergentdave authored Dec 5, 2023
1 parent e65aa23 commit 76df33b
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 5 deletions.
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,32 @@ and releases.

| Package version | Git branch | Protocol version | Conformant? | Status |
|---------------------|------------|-------------------------------------|-------------|-----------|
| 0.1.0 (forthcoming) | `main` | [`draft-ietf-ppm-dap-07`][draft-07] | Yes | Supported |
| 0.1.0 | `main` | [`draft-ietf-ppm-dap-07`][draft-07] | Yes | Supported |

[draft-07]: https://datatracker.ietf.org/doc/draft-ietf-ppm-dap/07/

## Usage

Note that no published releases are available yet, so you must build this
library from source for now. Add the AAR file to your project. Construct a
`Client` from your DAP task's parameters, and use it to send report as follows.
Ensure that Maven Central is in the list of repositories from which
dependencies are resolved. Add the library to your project as follows.

```groovy
// build.gradle
dependencies {
implementation 'org.divviup.android:divviup-android:0.1.0'
}
```

```kotlin
// build.gradle.kts

dependencies {
implementation("org.divviup.android:divviup-android:0.1.0")
}
```

Construct a `Client` from your DAP task's parameters, and use it to send report as follows.
(Note that this should be done off the main thread)

```java
Expand Down
2 changes: 1 addition & 1 deletion divviup/build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ android {
defaultConfig {
minSdk = 21

version = "0.1.0-SNAPSHOT"
version = "0.1.0"

testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
consumerProguardFiles("consumer-rules.pro")
Expand Down

0 comments on commit 76df33b

Please sign in to comment.