Skip to content

Commit c7a49eb

Browse files
authored
OPEN-103: Update README and ReleaseNotes (#43)
Update README and ReleaseNotes with usage instructions and change log
1 parent 06fce9b commit c7a49eb

File tree

2 files changed

+97
-10
lines changed

2 files changed

+97
-10
lines changed

README.md

Lines changed: 59 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,65 @@ without prior notice.**
4444

4545
We aim to support a broad set of operating systems and architectures, including:
4646

47-
| Platform | Architectures | Runtimes (examples) | Supported? |
48-
|---------------|---------------|----------------------------------|--------------|
49-
| Linux | x86_64 | Native Rust, JVM (tests/tooling) | Experimental |
50-
| Windows | x86_64 | Native Rust, JVM (tests/tooling) | Experimental |
51-
| macOS | arm64 | Native Rust, JVM (tests/tooling) | Experimental |
52-
| Android | arm64, x86_64 | JVM (Android, via JNI/NDK) | Experimental |
53-
| iOS | arm64 | Native | Experimental |
54-
| iOS Simulator | arm64 | Native | Experimental |
47+
| Platform | Architectures | Runtimes (examples) | Supported? |
48+
|---------------|---------------|----------------------------------|------------|
49+
| Linux | x86_64 | Native Rust, JVM (tests/tooling) | alpha |
50+
| Windows | x86_64 | Native Rust, JVM (tests/tooling) | alpha |
51+
| macOS | arm64 | Native Rust, JVM (tests/tooling) | alpha |
52+
| Android | arm64, x86_64 | JVM (Android, via JNI/NDK) | alpha |
53+
| iOS | arm64 | Native | alpha |
54+
alpha
55+
56+
## Usage / Artifacts
57+
58+
Published artifacts are available on Maven Central. Use the latest published version.
59+
60+
Kotlin Multiplatform (common dependency):
61+
62+
```kotlin
63+
kotlin {
64+
sourceSets {
65+
val commonMain by getting {
66+
dependencies {
67+
implementation("de.gematik.openhealth:healthcard:<version>")
68+
}
69+
}
70+
}
71+
}
72+
```
73+
74+
Android:
75+
76+
```kotlin
77+
repositories { mavenCentral() }
78+
79+
dependencies {
80+
implementation("de.gematik.openhealth:healthcard-android:<version>")
81+
}
82+
```
83+
84+
JVM:
85+
86+
```kotlin
87+
repositories { mavenCentral() }
88+
89+
dependencies {
90+
implementation("de.gematik.openhealth:healthcard-jvm:<version>")
91+
}
92+
```
93+
94+
### Swift (Xcode SwiftPM)
95+
96+
1. In Xcode, add a package dependency with the repository URL:
97+
`https://github.com/gematik/OpenHealth-Core`.
98+
2. Set the Dependency Rule to **Exact Version** and pick the desired release tag.
99+
3. Add the `OpenHealthHealthcard` product to your target.
100+
101+
Notes:
102+
103+
- The Swift package references the xcframework at
104+
`core-modules-swift/healthcard/OpenHealthHealthcardFFI.xcframework` inside the selected tag. If that file is missing
105+
for a given release, build it locally (see `core-modules-swift/healthcard/README.md`) or use the release asset.
55106

56107
## Contributing
57108

ReleaseNotes.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,42 @@ This document summarizes the publicly released versions of OpenHealth Core.
2727

2828
## Change Log
2929

30-
### LATEST
30+
### 0.0.1-alpha5 (Latest)
3131

32-
- Initial release.
32+
Added
33+
- FFI bindings for healthcard ([#18](https://github.com/gematik/OpenHealth-Core/pull/18)).
34+
- APDU tools, integration tests, and CV certificate parsing ([#36](https://github.com/gematik/OpenHealth-Core/pull/36), [#35](https://github.com/gematik/OpenHealth-Core/pull/35), [#39](https://github.com/gematik/OpenHealth-Core/pull/39)).
35+
- Initial OpenSSL build layer and crypto/EC module updates ([#8](https://github.com/gematik/OpenHealth-Core/pull/8), [#12](https://github.com/gematik/OpenHealth-Core/pull/12)).
36+
- CI checks, security policy, and release notes ([#13](https://github.com/gematik/OpenHealth-Core/pull/13), [#16](https://github.com/gematik/OpenHealth-Core/pull/16)).
37+
- Swift and Kotlin binding workflows and related packaging updates ([#25](https://github.com/gematik/OpenHealth-Core/pull/25)).
38+
39+
Changed
40+
- ASN.1 tag handling and EC key encoding refactor ([#10](https://github.com/gematik/OpenHealth-Core/pull/10)).
41+
- General API refactoring across modules ([#21](https://github.com/gematik/OpenHealth-Core/pull/21)).
42+
- Smartcard implementation refactor ([#15](https://github.com/gematik/OpenHealth-Core/pull/15)).
43+
- Rename trusted channel to secure channel ([#23](https://github.com/gematik/OpenHealth-Core/pull/23)).
44+
- Migration focus from KMP-first to Rust core.
45+
- Repository packaging and release workflow adjustments (Package.swift move, Swift wrapper handling, pipeline streamlining) ([#27](https://github.com/gematik/OpenHealth-Core/pull/27), [#28](https://github.com/gematik/OpenHealth-Core/pull/28), [#26](https://github.com/gematik/OpenHealth-Core/pull/26)).
46+
47+
Fixed
48+
- OpenSSL config ([#9](https://github.com/gematik/OpenHealth-Core/pull/9)).
49+
50+
Security
51+
- Replace CC0 with Apache-2.0 and add REUSE headers ([#14](https://github.com/gematik/OpenHealth-Core/pull/14), [#11](https://github.com/gematik/OpenHealth-Core/pull/11)).
52+
- Dynamic license header for generated `ossl.rs` ([#17](https://github.com/gematik/OpenHealth-Core/pull/17)).
53+
54+
Dependencies
55+
- Dependabot config/allowlist and dependency bumps ([#29](https://github.com/gematik/OpenHealth-Core/pull/29), [#33](https://github.com/gematik/OpenHealth-Core/pull/33), [#31](https://github.com/gematik/OpenHealth-Core/pull/31), [#32](https://github.com/gematik/OpenHealth-Core/pull/32), [#30](https://github.com/gematik/OpenHealth-Core/pull/30)).
56+
57+
### 0.0.1-alpha1 –> 0.0.1-alpha4
58+
- KMP → Rust core migration
59+
60+
### 0.1.2-POPP_RELEASE (June 23, 2025)
61+
62+
- Older version that only works with the JVM.
63+
- Backports from main for some test related fixes.
64+
65+
### 0.1.1-POPP_RELEASE (June 23, 2025)
66+
67+
- Older version that only works with the JVM.
68+
- Backports from main for some test related fixes.

0 commit comments

Comments
 (0)