Update README.md

Deduplicate changelog with links to individual generator changelogs.
NordSecurity · Nov 21, 2023 · 8b8eb84 · 8b8eb84
1 parent 6b7c48d
commit 8b8eb84
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 70 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # uniffi-generators - Hosting UniFFI bindings generators in docker images
 
-Official UniFFI project provides binding generator for Kotlin, Swift, Python and Ruby.
-In Nord we've developed external generators for C# and Go.
-This repository is hosting docker images that contain all three generators in the compatible versions.
+Official UniFFI project provides binding generator for Kotlin, Swift, Python and Ruby. At
+NordSecurity, we've created additional generators for C#, Go, and C++. This repository hosts Docker
+images with all these generators in their compatible versions.
 
 # How to use
 
@@ -15,61 +15,52 @@ Inside docker you can run:
 uniffi-bindgen generate src/definition.udl --language python
 uniffi-bindgen-cs src/definition.udl
 uniffi-bindgen-go src/definition.udl
+uniffi-bindgen-cpp src/definition.udl
 ```
 For the exact instructions on how to run individual generators please visit their respective repositories:
-[uniffi-bindgen](https://github.com/mozilla/uniffi-rs)
-[uniffi-bindgen-cs](https://github.com/NordSecurity/uniffi-bindgen-cs)
-[uniffi-bindgen-go](https://github.com/NordSecurity/uniffi-bindgen-go)
+- [uniffi-bindgen](https://github.com/NordSecurity/uniffi-rs)
+- [uniffi-bindgen-cs](https://github.com/NordSecurity/uniffi-bindgen-cs)
+- [uniffi-bindgen-go](https://github.com/NordSecurity/uniffi-bindgen-go)
+- [uniffi-bindgen-cpp](https://github.com/NordSecurity/uniffi-bindgen-cpp)
+
+*NOTE: `uniffi-bindgen` is a version-compatible fork of `mozilla/uniffi-rs`.*
 
 # Contributing
 
-For contribution guidelines, read [CONTRIBUTING.md](CONTRIBUTING.md)
+For contribution guidelines, read [CONTRIBUTING.md](CONTRIBUTING.md).
 
 # Versioning
 
-This project is versioned in sync with `uniffi-rs`. So e.g. generators compatible with uniffi
+This project is versioned in sync with `uniffi-rs`. Generators compatible with uniffi
 version `v0.23.0` will be tagged `v0.23.0-X` in this repository. `X` will be incremented
-each time one of the generators is updated e.g. because of the bug fix. The table below
+each time one of the generators is updated e.g. because of a bug fix. The table below
 shows which versions of each generator are inside the docker image.
 
 
 | Docker image           | uniffi-rs version     | uniffi-bindgen-cs version | uniffi-bindgen-go version | uniffi-bindgen-cpp version |
 |------------------------|-----------------------|---------------------------|---------------------------|----------------------------|
-| v0.25.0-1              | **v0.25.0-1 (FORK)**  | **v0.7.0+v0.25.0**        | **v0.2.0+v0.25.0**        | **v0.1.0+v0.25.0**         |
-| v0.23.0-6              | v0.23.0-3 (FORK)      | v0.4.0+v0.23.0            | v0.1.5+v0.23.0            | not present                |
-| v0.23.0-5              | v0.23.0-3 (FORK)      | **v0.4.0+v0.23.0**        | **v0.1.5+v0.23.0**        | not present                |
-| v0.23.0-4              | v0.23.0 (FORK)        | **v0.2.3+v0.23.0**        | **v0.1.3+v0.23.0**        | not present                |
-| v0.23.0-3 (DO NOT USE) | v0.23.0 (FORK)        | **v0.2.2+v0.23.0**        | v0.1.0+v0.23.0            | not present                |
+| v0.25.0-1              | **v0.3.0+0.25.0**     | **v0.7.0+v0.25.0**        | **v0.2.0+v0.25.0**        | **v0.1.0+v0.25.0**         |
+| v0.23.0-6              | v0.23.0-3             | v0.4.0+v0.23.0            | v0.1.5+v0.23.0            | not present                |
+| v0.23.0-5              | v0.23.0-3             | **v0.4.0+v0.23.0**        | **v0.1.5+v0.23.0**        | not present                |
+| v0.23.0-4              | v0.23.0               | **v0.2.3+v0.23.0**        | **v0.1.3+v0.23.0**        | not present                |
+| v0.23.0-3 (DO NOT USE) | v0.23.0               | **v0.2.2+v0.23.0**        | v0.1.0+v0.23.0            | not present                |
 | v0.23.0-2 (DO NOT USE) | v0.23.0               | v0.2.1+v0.23.0            | **v0.1.0+v0.23.0**        | not present                |
 | v0.23.0-1              | v0.23.0               | v0.2.1+v0.23.0            | not present               | not present                |
 
-### v0.23.0-6
-
-`uniffi-generators`
-- Include `python3` installation in the *docker* image
-
-### v0.23.0-5
-
-`uniffi-rs`:
-- Add missing docstrings to Kotlin flat enum variants
+# Changelog
 
-`uniffi-bindgen-go`:
-- **IMPORTANT**: Fix memory leak for all strings being read from FFI
-- Fix typo in generated Go bindings for associated enum case with no fields
+Version changelogs are available inside each individual project.
 
-`uniffi-bindgen-cs`:
-- **BREAKING**: flat enum variants are lowercase
-- Lowercase numeric types in generated bindings code
-- Fix missing imports when ImplicitUsings is not enabled
-- Allow configuration of global methods class name (uniffi.toml: global_methods_class_name)
+- [mozilla/uniffi-rs/CHANGELOG.md](https://github.com/mozilla/uniffi-rs/blob/main/CHANGELOG.md)
+- [NordSecurity/uniffi-rs/CHANGELOG.md](https://github.com/NordSecurity/uniffi-rs/blob/main/CHANGELOG.md)
+- [NordSecurity/uniffi-bindgen-cpp/CHANGELOG.md](https://github.com/NordSecurity/uniffi-bindgen-cpp/blob/main/CHANGELOG.md)
+- [NordSecurity/uniffi-bindgen-cs/CHANGELOG.md](https://github.com/NordSecurity/uniffi-bindgen-cs/blob/main/CHANGELOG.md)
+- [NordSecurity/uniffi-bindgen-go/CHANGELOG.md](https://github.com/NordSecurity/uniffi-bindgen-go/blob/main/CHANGELOG.md)
 
-### v0.23.0-4
+### v0.23.0-6
 
-uniffi-rs [fork](https://github.com/NordSecurity/uniffi-rs/commit/36de103c82d3e062ac045b13394b8ad387d23a67) changelist:
-- Docstrings support. See
-[mozilla/uniffi-rs/pull/1493](https://github.com/mozilla/uniffi-rs/pull/1493) and
-[mozilla/uniffi-rs/pull/1498](https://github.com/mozilla/uniffi-rs/pull/1498).
+- Include `python3` installation in the *docker* image
 
-### v0.23.0-2, v0.23.0-3
+### ~~v0.23.0-2~~, ~~v0.23.0-3~~
 
-Those versions have a severe bug which make those versions unusable. Do not use.
+These versions are not ABI compatible with upstream, and should not be used.
diff --git a/uniffi-bindgen/Cargo.toml b/uniffi-bindgen/Cargo.toml
@@ -4,4 +4,4 @@ version = "0.25.0"
 edition = "2021"
 
 [dependencies]
-uniffi = { git = "https://github.com/NordSecurity/uniffi-rs.git", tag = "v0.25.0-1", features = ["cli"] }
+uniffi = { git = "https://github.com/NordSecurity/uniffi-rs.git", tag = "v0.3.0+v0.25.0", features = ["cli"] }