Skip to content

Commit b5ff4ca

Browse files
committed
ensure documentation uses correct npm package
Signed-off-by: Ryan Tate <ryan.tate@spruceid.com>
1 parent 0e15f34 commit b5ff4ca

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

npm-package/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@ A WebAssembly-based Node.js/TypeScript package for the DC API, providing digital
55
## Installation
66

77
```bash
8-
npm install @spruceid/dc-api
8+
npm install @spruceid/opencred-dc-api
99
```
1010

1111
## Quick Start
1212

1313
```typescript
14-
import { DcApi, JsOid4VpSessionStore } from '@spruceid/dc-api';
14+
import { DcApi, JsOid4VpSessionStore } from '@spruceid/opencred-dc-api';
1515

1616
// Prepare your PKCS8 PEM encoded private key for signing
1717
const privateKeyPem = `-----BEGIN PRIVATE KEY-----
@@ -111,7 +111,7 @@ This package wraps a Rust WASM binary. To build the complete package:
111111
The main WebAssembly class generated by wasm-bindgen that provides DC API functionality.
112112

113113
```typescript
114-
import { DcApi } from '@spruceid/dc-api';
114+
import { DcApi } from '@spruceid/opencred-dc-api';
115115
```
116116

117117
#### Constructor
@@ -333,7 +333,7 @@ This package uses automated CI/CD workflows for testing, validation, and publish
333333
Every push and pull request triggers comprehensive testing:
334334

335335
- **WASM Build Validation**: Ensures the Rust/WASM build succeeds
336-
- **Package Structure**: Validates correct file locations and package.json structure
336+
- **Package Structure**: Validates correct file locations and package.json structure
337337
- **Integration Tests**: Tests that generated bindings load correctly
338338
- **Security Audits**: npm and Cargo dependency vulnerability scanning
339339
- **Code Quality**: Rust formatting and Clippy linting
@@ -363,7 +363,7 @@ Quick release workflow:
363363
# Increment version and create tag
364364
npm run release:minor # or release:patch, release:major
365365

366-
# Push the tag to trigger publishing
366+
# Push the tag to trigger publishing
367367
git push origin npm/v$(node -p "require('./package.json').version")
368368
```
369369

@@ -435,7 +435,7 @@ npm-package/
435435
## Example: Complete Flow
436436

437437
```typescript
438-
import { DcApi, JsOid4VpSessionStore } from '@spruceid/dc-api';
438+
import { DcApi, JsOid4VpSessionStore } from '@spruceid/opencred-dc-api';
439439

440440
async function main() {
441441
// Create session stores

npm-package/package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)