Add a readme for the @gitbook/api (#283)

* Add readme for the api package

* Always use production url for openapi spec

* Add changeset

Author: SamyPesse

.changeset/perfect-clocks-look.md

@@ -0,0 +1,5 @@
+---
+'@gitbook/api': patch
+---
+
+Document the @gitbook/api package and update the OpenAPI spec

packages/api/README.md

@@ -0,0 +1,21 @@
+# `@gitbook/api`
+
+Javascript (Browser and Node) API client for the [GitBook API](https://developer.gitbook.com/).
+
+## Installation
+
+```
+npm install @gitbook/api
+```
+
+## Usage
+
+```ts
+import { GitBookAPI } from '@gitbook/api';
+
+const gitbook = new GitBookAPI({
+    authToken: 'gb_abc,
+});
+
+const { data } = await gitbook..spaces.getSpaceById('abc');
+```

packages/api/build.sh

@@ -7,7 +7,7 @@ mkdir ./spec
 LOCAL_OPENAPI_FILE=../../../gitbook-x/packages/api-client/static/openapi.yaml
 
 if [[ -z "${GITBOOK_OPENAPI_URL}" ]]; then
-  OPENAPI_URL="https://api.gitbook-staging.com/openapi.yaml"
+  OPENAPI_URL="https://api.gitbook.com/openapi.yaml"
 else
   OPENAPI_URL="${GITBOOK_OPENAPI_URL}"
 fi

packages/api/package.json

@@ -7,6 +7,7 @@
     "version": "0.11.0",
     "sideEffects": false,
     "files": [
+        "README.md",
         "spec/**",
         "dist/**"
     ],