Skip to content

Commit ad41c28

Browse files
author
Dave Kozma
committed
Update README
1 parent 5594dd3 commit ad41c28

File tree

1 file changed

+27
-16
lines changed

1 file changed

+27
-16
lines changed

README.md

+27-16
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,24 @@ The [c2pa-node](https://github.com/contentauth/c2pa-node) repository implements
1010

1111
Contents:
1212

13-
- [Installation](#installation)
14-
- [Prerequisites](#prerequisites)
15-
- [Installing for use in a client app](#installing-for-use-in-a-client-app)
16-
- [Building custom binaries](#building-custom-binaries)
17-
- [Installing for project contributions](#installing-for-project-contributions)
18-
- [Testing](#testing)
19-
- [Usage](#usage)
20-
- [Creating a c2pa object](#creating-a-c2pa-object)
21-
- [Reading a manifest](#reading-a-manifest)
22-
- [Creating a manifest](#creating-a-manifest)
23-
- [Adding an ingredient](#adding-an-ingredient)
24-
- [Signing a manifest](#signing-a-manifest)
25-
- [API documentation](#api-documentation)
13+
- [C2PA Node.js](#c2pa-nodejs)
14+
- [Installation](#installation)
15+
- [Prerequisites](#prerequisites)
16+
- [Installing for use in a client app](#installing-for-use-in-a-client-app)
17+
- [Building custom binaries](#building-custom-binaries)
18+
- [Installing for project contributions](#installing-for-project-contributions)
19+
- [Testing](#testing)
20+
- [Usage](#usage)
21+
- [Creating a c2pa object](#creating-a-c2pa-object)
22+
- [Reading a manifest](#reading-a-manifest)
23+
- [Creating a manifest](#creating-a-manifest)
24+
- [Adding an ingredient](#adding-an-ingredient)
25+
- [Signing a manifest](#signing-a-manifest)
26+
- [Signing buffers](#signing-buffers)
27+
- [Signing files](#signing-files)
28+
- [Local signing](#local-signing)
29+
- [Remote signing](#remote-signing)
30+
- [API documentation](#api-documentation)
2631

2732
</div>
2833

@@ -56,13 +61,19 @@ Using pnpm:
5661
$ pnpm add c2pa-node
5762
```
5863

59-
This command downloads the latest Rust SDK and builds it as a binding locally (which is why Rust must be locally installed).
64+
This command will download precompiled binaries for the following systems:
65+
- Linux x86_64
66+
- Linux aarch64 (ARM)
67+
- Windows x86
68+
- Windows ARM
6069

61-
**Note**: In the future, CAI may create binary releases so you won't need to install Rust on your machine.
70+
**Note**: macOS will be coming as soon as we add signed builds.
71+
72+
For all other platforms, you will need Rust installed on your system, as the `postinstall` step will attempt to build our Rust SDK into a native Node.js module on your machine.
6273

6374
### Building custom binaries
6475

65-
For platforms or architectures that do not have Rust tooling installed, you may need to build custom binaries. To pre-build a binary, [install the Rust toolchain](https://www.rust-lang.org/tools/install) and then run the following commands on the target system or VM:
76+
For platforms or architectures that do not have a precompiled binaries or Rust tooling installed, you may need to build custom binaries. To pre-build a binary, [install the Rust toolchain](https://www.rust-lang.org/tools/install) and then run the following commands on the target system or VM:
6677

6778
```sh
6879
$ cd c2pa-node

0 commit comments

Comments
 (0)