Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update versions and feature flags #922

Merged
merged 3 commits into from
Feb 14, 2025
Merged

docs: Update versions and feature flags #922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1199b33
docs: Update versions and feature flags
crandmck Feb 12, 2025
b84b879
Updates based on Maurice's comments
crandmck Feb 13, 2025
36ea663
Merge branch 'main' into doc-vers-and-flags
crandmck Feb 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/release-notes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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

<!-- Not sure where this really belongs... -->
Expand Down
12 changes: 7 additions & 5 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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.
Expand All @@ -36,12 +36,14 @@ 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.
* `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` - Enable support for reading claims on PDF files.

### New API

Expand Down
Loading