chore(resolver): docs updated (#3573)

Emurgo · Aug 29, 2024 · dbdbaa6 · dbdbaa6
1 parent 8f998bf
commit dbdbaa6
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 15 deletions.
diff --git a/packages/resolver/README.md b/packages/resolver/README.md
@@ -20,39 +20,43 @@ or
 
 There are two strategies supported to get a crypto address:
 
-- **all**: Will attempt to resolve on all services.
-
-Response: `[{nameServer: 'cns', address: string | null, error: Error instance | null}, {nameServer: 'unstoppable', address: string | null, error: Error instance | null}, {nameServer: 'handle', address: string | null, error: Error instance | null}]`
-
+- **all**: Will attempt to resolve for all services.
 - **first**: Will return the service that resolves first.
 
-Response: `[{nameServer: 'cns' | 'unstoppable' | 'handle', address: string | null, error: Error instance | null}]`
-
 ## API Reference
 
 - **`resolverApiMaker`**
 
 Accepted arguments:
 
-  1. apiConfig: `{unstoppable: '<unstoppable api key>'}`
-  2. cslFactory: Cardano Serialization Library initiator
+1. apiConfig: `{unstoppable: '<unstoppable api key>'}`
+2. cslFactory: Cardano Serialization Library initiator
 
 Returns: `getCardanoAddresses`
 
-
- - **`getCardanoAddresses`**
+- **`getCardanoAddresses`**
 
 Accepted arguments:
 
-  1. resolve: `string`. Domain or handle to look for.
-  2. strategy: `all` | `first`
+1. resolve: `string`. Domain or handle to look for.
+2. strategy: `all` | `first`
 
 Returns depending on the strategy selected:
 
 All:
 
-`[{nameServer: 'cns', address: string | null, error: Error instance | null}, {nameServer: 'unstoppable', address: string | null, error: Error instance | null}, {nameServer: 'handle', address: string | null, error: Error instance | null}]`
+```typescript
+[
+  {nameServer: 'cns', address: string | null, error: Error instance | null},
+  {nameServer: 'unstoppable', address: string | null, error: Error instance | null},
+  {nameServer: 'handle', address: string | null, error: Error instance | null}
+]
+```
 
 First:
 
-`[{nameServer: 'cns' | 'unstoppable' | 'handle', address: string | null, error: Error instance | null}]`
+```typescript
+[
+  {nameServer: 'cns' | 'unstoppable' | 'handle', address: string | null, error: Error instance | null}
+]
+```
diff --git a/packages/resolver/package.json b/packages/resolver/package.json
@@ -8,7 +8,13 @@
     "resolver",
     "browser",
     "react",
-    "react-native"
+    "react-native",
+    "ada-handle",
+    "ada handle",
+    "cns",
+    "unstoppable domains",
+    "unstoppable-domains",
+    "domain"
   ],
   "homepage": "https://github.com/Emurgo/yoroi/packages/resolver#readme",
   "bugs": {