Skip to content

Commit 313a31f

Browse files
authored
docs: add missing link to the reference documentation (#67)
1 parent 6b1f690 commit 313a31f

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This SDK enables you to interact with Scaleway APIs.
77
* SDK only works from a node.js runtime, browser calls aren't supported yet.
88

99
**🔗  Important links:**
10-
* Reference documentation (soon)
10+
* [Reference documentation](https://scaleway.github.io/scaleway-sdk-js)
1111
* [Example projects](./examples)
1212
* [Developers website](https://developers.scaleway.com) (API documentation)
1313

@@ -71,13 +71,13 @@ for await (const page of api.listNamespaces()) {
7171

7272
The project is coded with Typescript, so don't hesitate to take advantage of it.
7373

74-
1. All **types of a product** are stored in `Product.version` namespace. For instance, `Image` interface of Registry v1 can be accessed with `Registry.v1.Image`.
74+
1. All **types of a product** are stored in the `Product.version` namespace. For instance, the `Image` interface of Registry v1 can be accessed with `Registry.v1.Image`.
7575

7676
2. We export **errors** in the namespace `Errors`, allowing you to differentiate the cases (e.g. `Errors.PermissionsDeniedError`).
7777

7878
## Dependencies
7979

80-
This SDK is based on the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API and use `Request`, `Response` & `Headers` interfaces. Those interfaces are native in modern browsers, node >=18 & [deno](https://deno.land/) environments.
80+
This SDK is based on the [fetch](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) API and uses `Request`, `Response` & `Headers` interfaces. Those interfaces are native in modern browsers, node >=18 & [deno](https://deno.land/) environments.
8181

8282
For `node` < 18 & `React Native` environments, the commonJS build requires [cross-fetch](https://www.npmjs.com/package/cross-fetch) package, it is listed in `dependencies` but not used in esm build.
8383

0 commit comments

Comments
 (0)