From 7b8fe4d0d0f29b2fb3c8d8775a100114eb1f8464 Mon Sep 17 00:00:00 2001 From: mixmix Date: Mon, 30 Sep 2024 12:15:01 +1300 Subject: [PATCH 1/3] link docs, refactor README.md Signed-off-by: mixmix --- README.md | 47 +++++++++++++++++++---------------------------- 1 file changed, 19 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 24290b8d4..414252a77 100644 --- a/README.md +++ b/README.md @@ -27,63 +27,54 @@ We also have edge agents for other platforms: - Agent: A component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols. ## Getting started +We highly recommend you [check out the online docs](https://hyperledger.github.io/identus-docs/docs/getting-started) :world_map: -This repository includes a browser and a Node.js demo application, and also a step-by-step documented process on [how to run it](#running-a-demo-project). - -### Use in your project -You can install and use this library in browsers and nodejs. +### Install ```bash -npm i @hyperledger/identus-edge-agent-sdk --save +npm i @hyperledger/identus-edge-agent-sdk ``` -or with yarn - +or ```bash yarn add @atala/prism-wallet-sdk ``` -### Running a demo project - -#### Building from source -This repository contains compiles typescript code and some rust dependencies for DIDComm and AnonCreds, so in order to build the code from source you will need the following: +### Demo application +This repository also includes a browser and a Node.js demo application +#### Build demo dependencies +The demos assume building this repo from source, so you will need the following: * Bash -* Have Rust ([cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)) and [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) installed. +* Rust ([cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)) and [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/) installed. * Node JS Version (20/LTS Recommended) -Clone the repository -``` -git clone git@github.com:hyperledger/identus-edge-agent-sdk-ts.git --recurse-submodules -``` - -To be able to run the demos, we have to build `identus-edge-agent-sdk-ts`. -From the repository root run: - +Clone and build: ```bash +git clone git@github.com:hyperledger/identus-edge-agent-sdk-ts.git --recurse-submodules +cd identus-agent-sdk-ts npm i npm run build ``` -### Running the sample applications -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. +#### Run the demos +Once you have [built the demo dependencies](#build-demo-dependencies), you can try out each of the demos: -Nodejs CommonJS +Nodejs Module: ```bash -cd demos/node-cjs +cd demos/node-esm npm i npm run start ``` -Nodejs Module +Nodejs CommonJS: ```bash -cd demos/node-esm +cd demos/node-cjs npm i npm run start ``` -Browser NextJS +Browser React / NextJS ```bash cd demos/next npm i From 64707cc714a4a98854dbf3c0a1096f487f038d5e Mon Sep 17 00:00:00 2001 From: mixmix Date: Mon, 30 Sep 2024 14:18:03 +1300 Subject: [PATCH 2/3] docs: fix README mis-naming package Signed-off-by: mixmix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 414252a77..ec5a810b3 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@ npm i @hyperledger/identus-edge-agent-sdk or ```bash -yarn add @atala/prism-wallet-sdk +yarn add @hyperledger/identus-edge-agent-sdk ``` ### Demo application From 100bd6bef0aa2658a0d08f4ef935309edaa04dc2 Mon Sep 17 00:00:00 2001 From: Pete Vielhaber Date: Mon, 30 Sep 2024 06:37:27 -0500 Subject: [PATCH 3/3] Update README.md Signed-off-by: Pete Vielhaber --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ec5a810b3..6d9e9db15 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ We also have edge agents for other platforms: - Agent: A component using all other building blocks, provides basic edge agent capabilities, including implementing DIDComm V2 protocols. ## Getting started -We highly recommend you [check out the online docs](https://hyperledger.github.io/identus-docs/docs/getting-started) :world_map: +We highly recommend you check out the [docs](https://hyperledger.github.io/identus-docs/docs/getting-started) :world_map: ### Install