Skip to content

Commit

Permalink
docs: link docs, refactor README.md (#298)
Browse files Browse the repository at this point in the history
Signed-off-by: mixmix <mix@protozoa.nz>
Signed-off-by: Pete Vielhaber <peter.vielhaber@iohk.io>
Co-authored-by: Pete Vielhaber <peter.vielhaber@iohk.io>
  • Loading branch information
mixmix and petevielhaber authored Oct 4, 2024
1 parent 9109173 commit 7b4542f
Showing 1 changed file with 20 additions and 29 deletions.
49 changes: 20 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [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
yarn add @hyperledger/identus-edge-agent-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
Expand Down

3 comments on commit 7b4542f

@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: 76%
76.29% (3541/4641) 66.4% (1544/2325) 79.98% (855/1069)

@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: 76%
76.29% (3541/4641) 66.4% (1544/2325) 79.98% (855/1069)

@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: 76%
76.29% (3541/4641) 66.4% (1544/2325) 79.98% (855/1069)

Please sign in to comment.