From 1199b33b8b69f5542fcb1186ab93c76c5b403592 Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Wed, 12 Feb 2025 15:21:05 -0800 Subject: [PATCH 1/2] docs: Update versions and feature flags --- docs/release-notes.md | 6 ++---- docs/usage.md | 14 +++++++++----- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/release-notes.md b/docs/release-notes.md index 865e724f2..88092ec5b 100644 --- a/docs/release-notes.md +++ b/docs/release-notes.md @@ -32,12 +32,12 @@ These features are now standard and the `unstable_api` feature is no longer used You can still use the deprecated API by enabling the `v1_api` feature; for example: ``` -c2pa = {version="0.39.0", features=["v1_api"]} +c2pa = {version="0.45.2", features=["v1_api"]} ``` ### API Changes for C2PA 2.1 -The C2PA 2.1 claims are experimental at this point and not fully implemented yet. +Support for claims as described in the [C2PA 2.1 specification](https://c2pa.org/specifications/specifications/2.1/specs/C2PA_Specification.html#_claims) is experimental at this point and not fully implemented yet. `Reader` has a new method: `validation_state()` which returns the a `ValidationState`. The `ValidationState` can be `Invalid`, `Valid` or `Trusted`. @@ -60,8 +60,6 @@ In v2 claims, the first `action` must be `c2pa.created` or `c2pa.opened`. There are many more checks and status codes added for v2 claims. - - ## Language binding support diff --git a/docs/usage.md b/docs/usage.md index 0c039a785..bd6928e6d 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -17,7 +17,7 @@ To use the library, add this to your `Cargo.toml`: ```toml [dependencies] -c2pa = "0.36.1" +c2pa = "0.45.2" ``` To read or write a manifest file, add the `file_io` dependency to your `Cargo.toml`. @@ -27,7 +27,7 @@ To read or write a manifest file, add the `file_io` dependency to your `Cargo.to Add the `add_thumbnails` dependency to generate thumbnails for JPEG and PNG files. For example: ``` -c2pa = { version = "0.39.0", features = ["file_io", "add_thumbnails"] } +c2pa = { version = "0.45.2", features = ["file_io", "add_thumbnails"] } ``` NOTE: If you are building for WASM, omit the `file_io` dependency. @@ -36,12 +36,16 @@ NOTE: If you are building for WASM, omit the `file_io` dependency. The Rust library crate provides the following capabilities: -* `file_io` enables manifest generation, signing via OpenSSL, and embedding manifests in [supported file formats](supported-formats.md). * `add_thumbnails` generates thumbnails automatically for JPEG and PNG files. (no longer included with `file_io`) -* `serialize_thumbnails` includes binary thumbnail data in the [Serde](https://serde.rs/) serialization output. -* `no_interleaved_io` forces fully-synchronous I/O; otherwise, the library uses threaded I/O for some operations to improve performance. * `fetch_remote_manifests` enables the verification step to retrieve externally referenced manifest stores. External manifests are only fetched if there is no embedded manifest store and no locally adjacent .c2pa manifest store file of the same name. +* `file_io` enables manifest generation, signing via OpenSSL, and embedding manifests in [supported file formats](supported-formats.md). * `json_schema` is used by `make schema` to produce a JSON schema document that represents the `ManifestStore` data structures. +* `no_interleaved_io` forces fully-synchronous I/O; otherwise, the library uses threaded I/O for some operations to improve performance. +* `openssl` - ?? +* `openssl_sign` - ?? +* `serialize_thumbnails` includes binary thumbnail data in the [Serde](https://serde.rs/) serialization output. +* `v1_api` - Use the old API (which will soon be deprecated) instead of the [new API](release-notes.md#new-api). +* `pdf` - ?? ### New API From b84b879a38f8e2b7924274335f9088627440b4fc Mon Sep 17 00:00:00 2001 From: Rand McKinney Date: Thu, 13 Feb 2025 15:42:04 -0800 Subject: [PATCH 2/2] Updates based on Maurice's comments --- docs/usage.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index bd6928e6d..023c3b37e 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -41,11 +41,9 @@ The Rust library crate provides the following capabilities: * `file_io` enables manifest generation, signing via OpenSSL, and embedding manifests in [supported file formats](supported-formats.md). * `json_schema` is used by `make schema` to produce a JSON schema document that represents the `ManifestStore` data structures. * `no_interleaved_io` forces fully-synchronous I/O; otherwise, the library uses threaded I/O for some operations to improve performance. -* `openssl` - ?? -* `openssl_sign` - ?? * `serialize_thumbnails` includes binary thumbnail data in the [Serde](https://serde.rs/) serialization output. * `v1_api` - Use the old API (which will soon be deprecated) instead of the [new API](release-notes.md#new-api). -* `pdf` - ?? +* `pdf` - Enable support for reading claims on PDF files. ### New API