Skip to content

Commit

Permalink
Merge pull request #20 from collectiveidea/prep-version-1.0.0
Browse files Browse the repository at this point in the history
Prep version 1.0.0
  • Loading branch information
darronschall authored Nov 26, 2024
2 parents d87b6f4 + 557daa2 commit 86846d9
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## [Unreleased]

## [1.0.0] - 2024-11-26

* Runtime - Refactor and cleanup `Any?` JSON deserialization. See [#19](https://github.com/collectiveidea/twirp-kmp/pull/19).
* Update dependencies. See [#17](https://github.com/collectiveidea/twirp-kmp/pull/17).
* Bump Kotlin from 2.0.20 to 2.0.21
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,20 @@ In general, follow [PBandK Usage](https://github.com/streem/pbandk#usage) instru

### Usage

Download the latest release, currently `0.4.0`, and pass it to `protoc` via `pbandk`:
Download the latest release, currently `1.0.0`, and pass it to `protoc` via `pbandk`:

```bash
# Download the library to ~
cd ~/
curl -OL https://github.com/collectiveidea/twirp-kmp/releases/download/0.4.0/twirp-kmp-generator-0.4.0.jar
curl -OL https://github.com/collectiveidea/twirp-kmp/releases/download/1.0.0/twirp-kmp-generator-1.0.0.jar
```


Pass the jar and generator class name as the `kotlin_service_gen` option to `pbandk_out`:

```bash
cd ~/exampleProject
protoc --pbandk_out=kotlin_service_gen='~/twirp-kmp-generator-0.4.0.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
protoc --pbandk_out=kotlin_service_gen='~/twirp-kmp-generator-1.0.0.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
```

### Build
Expand All @@ -36,12 +36,12 @@ To build the library locally, run:
./gradlew build
```

This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmp-generator-0.4.0-SNAPSHOT.jar`
This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmp-generator-1.0.0-SNAPSHOT.jar`

Then, the built version can be used, instead of the latest release, by supplying the path to the built `.jar`, e.g.:

```bash
protoc --pbandk_out=kotlin_service_gen='/Users/darron/Development/twirp-kmp/generator/build/libs/twirp-kmp-generator-0.4.0-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
protoc --pbandk_out=kotlin_service_gen='/Users/darron/Development/twirp-kmp/generator/build/libs/twirp-kmp-generator-1.0.0-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
```

## Runtime
Expand All @@ -51,7 +51,7 @@ The runtime provides an [`installTwirp`](./runtime/src/commonMain/kotlin/com/col
First, add the runtime as a dependency:

```
implementation "com.collectiveidea.twirp:twirp-kmp-runtime:0.4.0"
implementation "com.collectiveidea.twirp:twirp-kmp-runtime:1.0.0"
```

Then, configure the HttpClient and pass the client into the generated service constructor:
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version=0.4.0
version=1.0.0
group=com.collectiveidea.twirp

kotlin.code.style=official
Expand Down

0 comments on commit 86846d9

Please sign in to comment.