From 5874ed49606923fc6c5b5837f11682694ccdbef3 Mon Sep 17 00:00:00 2001 From: John Henderson Date: Thu, 7 Apr 2022 13:05:48 +0200 Subject: [PATCH] docs(index.md): remove out of date sections --- docs/index.md | 50 -------------------------------------------------- 1 file changed, 50 deletions(-) diff --git a/docs/index.md b/docs/index.md index 310b70a0..9fe65abb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,53 +9,3 @@ A [TypeScript](https://www.typescriptlang.org/) library that provides high-level You can read more about Decentralized Identifiers (DIDs), Verifiable Credentials and how they provide the mechanisms for identity access and management in EW-DOS [here](https://energy-web-foundation.gitbook.io/energy-web/foundational-concepts/self-sovereign-identity) - -### Prerequisites - -Node.js (>=10) - -### Add library as a dependency - -From Git: - -```sh -$ npm i https://github.com/energywebfoundation/iam-client-lib.git#branch_name -``` - -From NPM: - -```sh -$ npm i iam-client-lib -``` - -### Sample Import (TypeScript) -```sh -import { IAM, CacheServerClient } from 'iam-client-lib'; - -export class Sample { - private _iam: IAM; - - - constructor() { - // create default cache server client (optional) - const cacheClient = new CacheServerClient({ url: 'http://cache-server.com'}) - - // create IAM instance with provided rpc URL - this._iam = new IAM({ - rpcUrl: 'https://volta-rpc.energyweb.org/', - chainId: 73799, - cacheClient // optional - }); - } - - async initializeIAM() { - // this will show connection modal and authenticate - const { did, connected } = await this._iam.initializeConnection(); - - // after successfully authentication you can retrieve the signer - const signer = this._iam.getSigner(); - } - -``` - -## License \ No newline at end of file