Skip to content

Commit

Permalink
chore(release): release 4.0.1
Browse files Browse the repository at this point in the history
## [4.0.1](v4.0.0...v4.0.1) (2024-02-02)

### Bug Fixes

* Manually generating the missing changelog and breaking changes b… ([#167](#167)) ([6927a34](6927a34))
  • Loading branch information
atala-dev committed Feb 2, 2024
1 parent 6927a34 commit 84efa71
Show file tree
Hide file tree
Showing 238 changed files with 2,726 additions and 1,531 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [4.0.1](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/compare/v4.0.0...v4.0.1) (2024-02-02)


### Bug Fixes

* Manually generating the missing changelog and breaking changes b… ([#167](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/issues/167)) ([6927a34](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/commit/6927a34a694250014f82231c5c78425d04110780))

# [4.0.0](https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/compare/v3.1.0...v4.0.0) (2024-02-02)

* fix: removing terser to allow an unminified build that is easier to d… by @elribonazo in https://github.com/input-output-hk/atala-prism-wallet-sdk-ts/pull/127
Expand Down
38 changes: 14 additions & 24 deletions docs/sdk/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@input-output-hk/atala-prism-wallet-sdk / [Exports](modules.md)
@atala/prism-wallet-sdk / [Exports](modules.md)

# Atala PRISM TypeScript SDK

Expand Down Expand Up @@ -40,10 +40,6 @@ or with yarn
yarn add @atala/prism-wallet-sdk
```

> **Note for Webpack:**
>
> The application builds code with wasm files for DIDComm and Anoncreds for both browsers and nodejs. When webpack builds public website the wasm files need to be copied manually into the public folder. See examples
### Running a demo project

#### Building from source
Expand All @@ -66,44 +62,38 @@ npm i
npm run build
```

### For NodeJS CJS

After building `prism-wallet-sdk`, cd into `{path}/demos/node-cjs` or use visual studio debugger "CJS DEMO":
### Running the sample applications
We have enabled sample implementations for browser (react or nextjs) and nodejs.
In order to run each demo, make sure the whole SDK is built from source, then cd into the demo.

Nodejs CommonJS
```bash
cd demos/node-cjs
npm i
npm run start
```

> **Note:**
>
> The installation in the `{path}/demos/node-cjs` directory requires the `build` folder from the wallet-sdk to be available.
### For NodeJS ESM

After building `prism-wallet-sdk`, cd into `{path}/demos/node-esm` or use visual studio debugger "ESM DEMO":

Nodejs Module
```bash
cd demos/node-esm
npm i
npm run start
```

> **Note:**
>
> The installation in the `{path}/demos/node-esm` directory requires the `build` folder from the wallet-sdk to be available.
### For browser

After building `prism-wallet-sdk`, cd into the demo directory `{path}/demos/browser`

Browser React
```bash
cd demos/browser
npm i
npm run start
```

Browser NextJS
```bash
cd demos/next
npm i
npm run start
```

### Implementing storage for the SDK
This SDK exposes Pluto, a storage interface that should be implemented by the user, in the most appropriate way for a particular use case.

Expand Down
Loading

1 comment on commit 84efa71

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lines Statements Branches Functions
Coverage: 62%
62.22% (1260/2025) 50.64% (547/1080) 64.12% (370/577)

JUnit

Tests Skipped Failures Errors Time
335 2 💤 0 ❌ 0 🔥 37.847s ⏱️

Please sign in to comment.