Prepare version 0.3.0

CHANGELOG.md

@@ -4,11 +4,22 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2023-02-15
+
+### Added
+
+ * Runtime - Added helper method to `ServiceException` for checking `304 Not Modified` server response. See [#5](https://github.com/collectiveidea/twirp-kmm/pull/5).
+
+### Changed
+
+ * Generator - Generated service methods now return a `Pair`, to access response headers. See [#4](https://github.com/collectiveidea/twirp-kmm/pull/4).
+ * Generator - `requestHeaders` type changed from `Map<String, String>` to `Header` for consistency with `Pair` result. See [#4](https://github.com/collectiveidea/twirp-kmm/pull/4).
+
 ## [0.2.0] - 2023-02-13
 
 ### Added
 
- * Generated service methods now accept optional request headers. See [#2](https://github.com/collectiveidea/twirp-kmm/pull/2).
+ * Generator - Generated service methods now accept optional request headers. See [#2](https://github.com/collectiveidea/twirp-kmm/pull/2).
 
 ## [0.1.0] - 2022-12-05
 

README.md

@@ -10,20 +10,20 @@ In general, follow [PBandK Usage](https://github.com/streem/pbandk#usage) instru
 
 ### Usage
 
-Download the latest release, currently `0.2.0`, and pass it to `protoc` via `pbandk`:
+Download the latest release, currently `0.3.0`, and pass it to `protoc` via `pbandk`:
 
 ```bash
 # Download the library to ~
 cd ~/
-curl -OL https://github.com/collectiveidea/twirp-kmm/releases/download/0.2.0/twirp-kmm-generator-0.2.0.jar
+curl -OL https://github.com/collectiveidea/twirp-kmm/releases/download/0.3.0/twirp-kmm-generator-0.3.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-kmm-generator-0.2.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-kmm-generator-0.3.0.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:src/main/kotlin src/main/proto/example.proto
 ```
 
 ### Build
@@ -34,12 +34,12 @@ To build the library locally, run:
 ./gradlew build
 ```
 
-This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmm-generator-0.2.0-SNAPSHOT.jar`
+This creates the versioned `.jar` file, e.g. `generator/build/libs/twirp-kmm-generator-0.3.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-kmm/generator/build/libs/twirp-kmm-generator-0.2.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-kmm/generator/build/libs/twirp-kmm-generator-0.3.0-SNAPSHOT.jar|com.collectiveidea.twirp.Generator',kotlin_package=com.example.api:shared/src/commonMain/kotlin shared/src/commonMain/proto/example.proto
 ```
 
 ## Runtime
@@ -49,7 +49,7 @@ The runtime provides an [`installTwirp`](./runtime/src/commonMain/kotlin/com/col
 First, add the runtime as a dependency:
 
 ```
-implementation "com.collectiveidea.twirp:twirp-kmm-runtime:0.2.0"
+implementation "com.collectiveidea.twirp:twirp-kmm-runtime:0.3.0"
 ```
 
 Then, configure the HttpClient and pass the client into the generated service constructor:

gradle.properties

@@ -1,4 +1,4 @@
-version=0.2.0
+version=0.3.0
 group=com.collectiveidea.twirp
 
 kotlin.code.style=official