Skip to content

Commit 864b026

Browse files
committed
Copy edits to README
1 parent e776dc6 commit 864b026

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

tests/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,40 @@
1-
# C2PA Client Documentation
1+
# C2PA Python example client
22

3-
This directory contains the client for signing JPEG images with content credentials. This client is designed to work with the C2PA Python Example server in development mode using demo certificates (included in this repository).
3+
NOTE: This documentation is for the example developer.
4+
5+
This directory contains the client for signing JPEG images with Content Credentials. The client works with the C2PA Python example server in development mode using demo certificates (included in this repository).
46

57
## Overview
68

7-
The `client.py` file is a command-line test tool that signs JPEG image files. It connects to the signing server defined in `app.py`, to add Content Credentials to JPEG images.
9+
The `client.py` file is a command-line test tool that signs JPEG image files. It connects to the signing server defined in `app.py` to add Content Credentials to JPEG images.
810

911
## Prerequisites
1012

11-
1. **Python Dependencies**: Install required packages:
13+
1. Install Python Dependencies:
1214

1315
```bash
1416
pip install -r requirements.txt
1517
```
1618

17-
2. **Running signing Server**: The signing server (`app.py`) must be running using local certificates and accessible to the client:
19+
2. Run signing server (`app.py`). It uses local certificates and must be accessible to the client:
1820

1921
```bash
2022
python app.py
2123
```
2224

23-
3. **Image Files**: JPEG images to be signed
25+
3. Provide image files to be signed.
2426

2527
## Usage
2628

27-
Only JPEG images are supported with this test client.
29+
NOTE: This test client supports only JPEG images.
2830

29-
### Basic Command
31+
### Basic command
3032

3133
```bash
3234
python tests/client.py <image-file> -o <output-directory>
3335
```
3436

35-
### Command Line Arguments
37+
### Command line arguments
3638

3739
| Argument | Type | Required | Description |
3840
|----------|------|----------|-------------|

0 commit comments

Comments
 (0)