@namefi/api-client 0.0.0-pre.1 → 0.0.0-pre.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -12
- package/package.build.json +1 -1
- package/package.json +1 -1
- package/package.publish.json +1 -1
package/README.md
CHANGED
|
@@ -1,15 +1,16 @@
|
|
|
1
|
-
|
|
1
|
+
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
|
|
4
|
+
# [Namefi API Client](https://namefi.io)
|
|
4
5
|
|
|
5
6
|
> This package is still in alpha. APIs and behavior may change without notice.
|
|
6
7
|
|
|
8
|
+
> For [Full docs](https://namefi.io/public/docs/api)
|
|
9
|
+
|
|
7
10
|
## Table of Contents
|
|
8
11
|
|
|
9
12
|
- [Installation](#installation)
|
|
10
13
|
- [Usage](#usage)
|
|
11
|
-
- [Authentication](#authentication)
|
|
12
|
-
- [Contract](#contract)
|
|
13
14
|
|
|
14
15
|
## Installation
|
|
15
16
|
|
|
@@ -42,11 +43,3 @@ if (result.availability) {
|
|
|
42
43
|
console.log('Registered', order.id);
|
|
43
44
|
}
|
|
44
45
|
```
|
|
45
|
-
|
|
46
|
-
## Authentication
|
|
47
|
-
|
|
48
|
-
Provide an API key through the `authentication` option when creating the client.
|
|
49
|
-
|
|
50
|
-
## Contract
|
|
51
|
-
|
|
52
|
-
The client is generated against the bundled `contract.json` OpenAPI contract, which defines the available routes and shapes.
|
package/package.build.json
CHANGED
package/package.json
CHANGED