@allthings/sdk 8.0.0 → 8.1.1

package/README.md

@@ -4,19 +4,19 @@ Allthings Node/Javascript SDK
 
 ## Contents
 
-1.  [Installation & Usage](#installation--usage)
-1.  [Configuration](#configuration)
+1. [Installation & Usage](#installation--usage)
+2. [Configuration](#configuration)
     1.  [Options](#configuration-options)
-1.  [Authentication](#authentication)
-1.  [API](#api)
-1.  [OAuth Implicit Grant Example](#oauth-implicit-grant-example-example)
-1.  [OAuth Authorization Code Grant Example](#oauth-authorization-code-grant-example)
-1.  [Release management & versioning](#release-management--versioning)
+3. [Authentication](#authentication)
+4. [API](#api)
+5. [OAuth Implicit Grant Example](#oauth-implicit-grant-example-example)
+6. [OAuth Authorization Code Grant Example](#oauth-authorization-code-grant-example)
+7. [Release management & versioning](#release-management--versioning)
 
 ## Installation & Usage
 
 ```sh
-yarn add @allthings/sdk
+yarn add -DE @allthings/sdk
 ```
 
 ```javascript
@@ -31,20 +31,6 @@ client
   .then((viewer) => console.log(`Welcome back ${viewer.username}!`))
 ```
 
-<!--
-```javascript
-const allthingsSdk = require('@allthings/sdk')
-
-const allthings = allthingsSdk({
-  accessToken: '043dab7447450772example1214b552838003522',
-})
-
-allthings.query.viewer().then(viewer =>
-  console.log(`Welcome back ${viewer.username}!`)
-)
-```
--->
-
 ## Configuration
 
 ### Request logs
@@ -58,7 +44,7 @@ value can be anything which is truthy.
 The available configuration options are outlined here:
 
 | Option           | Default | Description                                                                                                                     |
-| ---------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------- |
+|------------------|---------|---------------------------------------------------------------------------------------------------------------------------------|
 | **accessToken**  |         | API Access Token                                                                                                                |
 | **clientId**     |         | OAuth 2.0 clientId                                                                                                              |
 | **clientSecret** |         | OAuth 2.0 client secret                                                                                                         |
@@ -95,23 +81,23 @@ client
 ## OAuth Authorization Code Grant Example
 
 1. Initialize instance of `client`:
-
-```javascript
-const allthings = require('@allthings/sdk')
-
-const client = allthings.restClient({
-  clientId: '5d038ef2441f4de574005c54_example',
-  clientSecret: '40f63f981ff082dbc8d273983ac3852c2e51e90856123156',
-  redirectUri: 'https://example-app.com/callback',
-})
-```
+  
+  ```javascript
+  const allthings = require('@allthings/sdk')
+  
+  const client = allthings.restClient({
+    clientId: '5d038ef2441f4de574005c54_example',
+    clientSecret: '40f63f981ff082dbc8d273983ac3852c2e51e90856123156',
+    redirectUri: 'https://example-app.com/callback',
+  })
+  ```
 
 2. Construct a URI to send authorization request to using a `state` which should be unique per request and hard to guess. It can be generated with `client.oauth.generateState()` method:
 
-```javascript
-const state = client.oauth.generateState()
-const authorizationUri = client.oauth.authorizationCode.getUri(state)
-```
+  ```javascript
+  const state = client.oauth.generateState()
+  const authorizationUri = client.oauth.authorizationCode.getUri(state)
+  ```
 
 3. Direct user's browser to the constructed URI.
 
@@ -476,14 +462,33 @@ See semantic-releases [docs](https://github.com/semantic-release/semantic-releas
 
 ### Development release
 
-In some cases you need to release a new version of the SDK without merging a PR. It could be done manually by running the following command:
+1. **Create or check out the target branch** from the commit you want to release:
 
-```sh
-yarn build && yarn publish --new-version <latest version + 1>-dev.x --tag dev --access public
-```
+   ```sh
+   git checkout -b beta   # or alpha / next
+   ```
+
+2. **Push the branch** to trigger the CI pipeline:
+
+   ```sh
+   git push --force origin HEAD:beta   # or alpha / next
+   ```
 
-where `<latest version>` is a tag from https://www.npmjs.com/package/@allthings/sdk?activeTab=versions (could be retrieved by running `npm view @allthings/sdk version`) and `x` is a new number of development version
+   The pipeline will automatically run `semantic-release`, which detects the branch name, bumps the version with the appropriate pre-release tag, and publishes it to npm under the matching dist-tag. Check [Actions page](https://github.com/allthings/cloud-toolkit/actions) for the release logs.
 
+3. **Install the pre-release** in another project:
+
+   ```sh
+   npm install @allthings/cloud-toolkit@beta   # or @alpha / @next
+   ```
+
+   or use exact release (check [versions on npm](https://www.npmjs.com/package/@allthings/cloud-toolkit?activeTab=versions)):
+
+   ```sh
+   npm install @allthings/cloud-toolkit@x.x.x-beta.x
+   ```
+
+4. **Promote to stable** – once the pre-release is validated, create a PR form your target branch.
 
 ## Local tests
 
@@ -498,9 +503,9 @@ ALLTHINGS_OAUTH_PASSWORD="<oauth_password>" \
 
 ```
 
-if you don't want to init the shell, please also provide next env variables to command as well: 
+if you don't want to init the shell, please also provide next env variables to command as well:
+
 - ALLTHINGS_ACCOUNTS_RECAPTCHA_SECRET_KEY
 - SSL_PASS
 
 Credentials could be found in `dev.secrets` repo.
-