diff --git a/README.md b/README.md index 99b621d14..3d7a0bec4 100644 --- a/README.md +++ b/README.md @@ -69,8 +69,8 @@ npm run build ``` ### 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. +We have enabled sample implementations for browsers (React or Next.js) and Node.js. +To run each demo, ensure the whole SDK builds from the source, then cd into the demo. Nodejs CommonJS ```bash diff --git a/docs/examples/SDKVerification.md b/docs/examples/SDKVerification.md index 45e61e296..6a47b28a2 100644 --- a/docs/examples/SDKVerification.md +++ b/docs/examples/SDKVerification.md @@ -1,8 +1,8 @@ # Cross-Platform Edge SDK Verification ## Requirements 1. A working Identus Mediator and an Identus Cloud Agent. -2. A holder which already has a JWT Credential issued by a known issuer (prism:did) [Holder A] -3. A holder which does not have credential but aims to start the Verification [Holder B (verifier)] +2. A holder who already has a JWT Credential issued by a known issuer (prism:did) [Holder A] +3. A holder who does not have credentials but aims to start the Verification [Holder B (verifier)] 4. Holder A shares its peerDID with holder B. 5. Holder B will initiate a presentation request @@ -33,17 +33,17 @@ 1. Holder B Initiates the Presentation Request: creating a PresentationDefinitionRequest with specified requirements. 2. Holder A, will then create a Presentation Submission which contains the requested credential together with a randomised challenge. 3. Holder B, will receive the Presentation Submission and verify the following - * Holder A signed the JWT presentation with the correct signatures. - * Holder A signed the random challenge that we required him with the correct keys. - * Holder A is including his credential and not somebody else's. - * Holder A is including a credential with valid signatures, matching the issuer through the specified DID. - * (optional) Holder A has included a credential that has been issued by the requested issuer. + * Holder A signed the JWT presentation with the correct signatures. + * Holder A signed the random challenge that required him to have the correct keys. + * Holder A is including a credentials it owns and not somebody else's. + * Holder A is includes a credential with valid signatures, matching the issuer through the specified DID. + * (optional) Holder A has included a credential that the requested issuer has issued. * (optional) Holder A has included a credential that satisfies the requested claims. -4. Holder B, can then verify at any point in time that presentation request and show feedback in UI. +4. Holder B can then verify at any point in time that presentation request and show feedback in UI. ## Code Reference -* toDID is the peer did of holder A which has the credential that we aim to verify -* claims contains an object with all the claims that we aim to validate, setting claims is internally used to help the Holder A to choose the right credential and to verify the fields correctly when Holder B receives the presentation. +* toDID is the peer did of holder A, which has the credential that we aim to verify +* claims contain an object with all the claims we aim to validate; setting claims is internally used to help Holder A choose the proper credential and correctly verify the fields when Holder B receives the presentation. Example ```javascript const claims: Claims = { diff --git a/docs/examples/index.md b/docs/examples/index.md index 0aa394773..fc65de1d9 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -1,11 +1,11 @@ # Identus Edge SDK TS Examples -Here you can find basic implementations and tutorials for the Identus Edge Agent JS SDK, but most things run cross platform with minor differences. +Here, we have the basic implementations and tutorials for the Identus Edge Agent JS SDK, but most things run cross platform with minor differences. ## Tutorials ### Cross platform DK Verification -Start a verification flow from an Edge Agent (holder wallet) and another holder to request (a did) to send you a credenital proof for a specific issuer and specific claims. +Start a verification flow from an Edge Agent (holder wallet) and another holder to request (a did) to send you a credential proof for a specific issuer and specific claims. [Start tutorial](./SDKVerification.md) \ No newline at end of file diff --git a/docs/sdk/README.md b/docs/sdk/README.md index d428e5da0..3d7a0bec4 100644 --- a/docs/sdk/README.md +++ b/docs/sdk/README.md @@ -1,5 +1,3 @@ -@atala/prism-wallet-sdk / [Exports](modules.md) - # Atala PRISM TypeScript SDK [![Coverage Status](https://coveralls.io/repos/github/input-output-hk/atala-prism-wallet-sdk-ts/badge.svg?branch=master)](https://coveralls.io/github/input-output-hk/atala-prism-wallet-sdk-ts?branch=master) @@ -71,8 +69,8 @@ npm run build ``` ### 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. +We have enabled sample implementations for browsers (React or Next.js) and Node.js. +To run each demo, ensure the whole SDK builds from the source, then cd into the demo. Nodejs CommonJS ```bash @@ -108,4 +106,5 @@ This SDK exposes Pluto, a storage interface that should be implemented by the us We don't provide a default implementation out of the box at the moment, but we do provide a couple of demo implementations that can be used to get started with demos and testing. -Provided demo implementations are intentionally oversimplified and SHOULD NOT be used in production. +Provided demo implementations are intentionally oversimplified and SHOULD NOT be used in production. +