Skip to content

Commit 6acb4b8

Browse files
author
Rand McKinney
committed
More README edits
1 parent 3172d41 commit 6acb4b8

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Import the C2PA module as follows:
2222
import c2pa-python as c2pa
2323
```
2424

25-
### Reading and validating C2PA data in a file
25+
### Read and validate C2PA data in a file
2626

2727
Use the `verify_from_file_json` function to read C2PA data from the specified file:
2828

@@ -38,9 +38,9 @@ If the optional `data_dir` is provided, the function extracts any binary resourc
3838

3939
NOTE: For a comprehensive reference to the JSON manifest structure, see the [CAI manifest store reference](https://contentauth.github.io/json-manifest-reference/manifest-reference).
4040

41-
### Adding a signed manifest to a media file
41+
### Add a signed manifest to a media file
4242

43-
The `add_manifest_to_file_json` function adds a signed manifest to a media file.
43+
Use the `add_manifest_to_file_json` function to add a signed manifest to a media file.
4444

4545
```py
4646
result = c2pa.add_manifest_to_file_json("path/to/source.jpg",
@@ -51,11 +51,11 @@ result = c2pa.add_manifest_to_file_json("path/to/source.jpg",
5151
```
5252

5353
The parameters (in order) are:
54-
- The source media file that will receive new C2PA data.
54+
- The source (original) media file.
5555
- The destination file that will contain a copy of the source file with the manifest data added.
5656
- `manifest_json`, a JSON-formatted string containing the manifest data you want to add; see [Creating a manifest JSON definition file](#creating-a-manifest-json-definition-file) below.
5757
- `sign_info`, a `SignerInfo` object instance; see [Generating SignerInfo](#generating-signerinfo) below.
58-
- The optional `data_dir` enables you to load resource files referenced from `manifest_json` identifiers. When building your manifest, any files referenced by identifier fields are loaded relative to this path. This enables you to load thumbnails, icons, and manifest data for ingredients.
58+
- `data_dir` optionally specifies a directory path from which to load resource files referenced in the manifest JSON identifier fields; for example, thumbnails, icons, and manifest data for ingredients.
5959

6060
### Generating SignerInfo
6161

@@ -66,7 +66,7 @@ certs = open("path/to/public_certs.pem","rb").read()
6666
prv_key = open("path/to/private_key.pem","rb").read()
6767
```
6868

69-
Then create a new `SignerInfo` instance using those keys as follows, specifying the signing algorithm used and optionally a time stamp authority URL:
69+
Then create a new `SignerInfo` instance using the keys as follows, specifying the signing algorithm used and optionally a time stamp authority URL:
7070

7171
```py
7272
sign_info = c2pa.SignerInfo(certs, priv_key, "es256", "http://timestamp.digicert.com")

0 commit comments

Comments
 (0)