Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: link docs, refactor README.md #298

Merged
merged 3 commits into from
Oct 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading