Skip to content

Commit a8bbb9b

Browse files
author
Chris Chinchilla
committed
Updates
Signed-off-by: Chris Chinchilla <[email protected]>
1 parent 840dde2 commit a8bbb9b

File tree

1 file changed

+11
-24
lines changed

1 file changed

+11
-24
lines changed

docs/develop/01_sdk/04_integrate/04_extension_api.md

Lines changed: 11 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,20 @@ import TabItem from '@theme/TabItem';
1010
The KILT Extension API is a JavaScript and TypeScript library that provides helper functions for interacting with KILT extensions.
1111
It facilitates communication between your application and KILT extensions.
1212

13-
## Installation
14-
15-
Add the package:
16-
17-
<Tabs groupId="ts-js-choice">
18-
<TabItem value='ts' label='Typescript' default>
1913

20-
```bash
21-
yarn add @kiltprotocol/kilt-extension-api
22-
```
2314

24-
</TabItem>
25-
<TabItem value='js' label='Javascript'>
15+
## Installation
2616

27-
```bash
28-
npm install --save @kiltprotocol/kilt-extension-api
29-
```
17+
Add the package:
3018

31-
</TabItem>
32-
</Tabs>
19+
```bash npm2yarn
20+
npm install --save @kiltprotocol/kilt-extension-api
21+
```
3322

3423
## Initialize Extension API
3524

3625
Before your application can communicate with KILT extensions, call the `initializeKiltExtensionAPI()` method to signal the API versions supported by your application so the extension can inject the appropriate scripts.
26+
This should happen at the earliest point possible on page load, or it won't inject the scripts.
3727

3828
<Tabs groupId="ts-js-choice">
3929
<TabItem value='ts' label='Typescript' default>
@@ -151,19 +141,16 @@ The following is an example of how you can use this method in a React applicatio
151141
</TabItem>
152142
</Tabs>
153143

154-
## Well-Known DID Configuration
144+
## DID Configuration
145+
146+
You need [an existing DID configuration](../../01_sdk/02_cookbook/01_dids/00_generate_keys.md) setup for your application to communicate with KILT extensions.
155147

156148
This library helps set up the [Well-Known DID Configuration](https://identity.foundation/.well-known/resources/did-configuration/) as required by the [KILT Credential API specification](https://github.com/KILTprotocol/spec-ext-credential-api).
157149

158150
### Using the CLI Tool
159151

160-
This library includes a CLI tool to create a [DID Configuration Resource](https://identity.foundation/.well-known/resources/did-configuration/#did-configuration-resource). This resource is necessary to establish a secure, end-to-end encrypted communication channel between a conforming browser extension and the application backend.
161-
162-
:::warning KILT Account
163-
164-
The `createDidConfig` CLI tool **only** works if you installed the package with Yarn.
165-
166-
:::
152+
This library includes a CLI tool to create a [DID Configuration Resource](https://identity.foundation/.well-known/resources/did-configuration/#did-configuration-resource).
153+
This resource is necessary to establish a secure, end-to-end encrypted communication channel between a conforming browser extension and the application backend.
167154

168155
Run the CLI tool using Yarn as follows:
169156

0 commit comments

Comments
 (0)