Skip to content

Commit 506feb1

Browse files
committed
Update README for new Node package name
1 parent 7d3641a commit 506feb1

File tree

1 file changed

+6
-19
lines changed

1 file changed

+6
-19
lines changed

README.md

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,10 @@
11
# C2PA Node.js library
22

3-
The [c2pa-node](https://github.com/contentauth/c2pa-node-v2) repository implements a Node.js API that can:
3+
The [c2pa-node-v2](https://github.com/contentauth/c2pa-node-v2) repository implements a Node.js API that can:
44
- Read and validate C2PA data from media files in supported formats.
55
- Add signed manifests to media files in supported formats.
66

7-
For more information on using the library in an application, see [Using the CAI Node library](docs/usage.md).
8-
9-
**WARNING**: This is an early prerelease version of this library. There may be bugs and unimplemented features, and the API is subject to change.
10-
11-
<div style={{display: 'none'}}>
12-
13-
For the best experience, read the docs on the [CAI Open Source SDK documentation website](https://opensource.contentauthenticity.org/docs/c2pa-node/). Some additional documentation for this repository is also available on GitHub:
14-
15-
- [Using the Node library](docs/usage.md)
16-
- [Supported media file formats](https://opensource.contentauthenticity.org/docs/c2pa-node/supported-formats)
17-
- [Release notes](docs/release-notes.md)
18-
- [Contributing to the project](docs/project-contributions.md)
19-
20-
</div>
7+
**WARNING**: This is an early version of this library, and there may be bugs and unimplemented features.
218

229
## Prerequisites
2310

@@ -29,24 +16,24 @@ If you need to manage multiple versions of Node on your machine, use a tool such
2916

3017
## Installation
3118

32-
### Installing for use in a client app
19+
### Installing for use in an app
3320

3421
Using npm:
3522

3623
```sh
37-
$ npm install c2pa-node
24+
$ npm install @contentauth/c2pa-node
3825
```
3926

4027
Using Yarn:
4128

4229
```sh
43-
$ yarn add c2pa-node
30+
$ yarn add @contentauth/c2pa-node
4431
```
4532

4633
Using pnpm:
4734

4835
```sh
49-
$ pnpm add c2pa-node
36+
$ pnpm add @contentauth/c2pa-node
5037
```
5138

5239
This command will download precompiled binaries for the following systems:

0 commit comments

Comments
 (0)