@findhotel/sapi 1.14.6-beta.0 → 1.14.6

package/README.md

@@ -9,11 +9,13 @@ hotels, hotels\' offers and rooms.
 - [Table of contents](#table-of-contents)
 - [Release process](#release-process)
   - [GitHub Token](#github-token)
+  - [NPM Registry](#npm-registry)
   - [New release](#new-release)
   - [New release from a development branch](#new-release-from-a-development-branch)
 - [Tutorials](#tutorials)
   - [Getting Started](#getting-started)
   - [React Native](#react-native)
+  - [Playground](#playground)
   - [Usage](#usage)
     - [Search](#search)
     - [Get hotel's rooms offers](#get-hotels-rooms-offers)
@@ -77,6 +79,14 @@ creates a PR before publishing every release, so this allows:
 - Edit the automatically generated changelog for clarity &
   readability.
 
+## NPM Registry
+
+NPM account is required for pre-release (beta) process:
+
+- Go to [NPM sign up](https://www.npmjs.com/signup)
+- Create an account and ask SAPI to give you access to organization
+- Activate your Two Factor Authentication using Authenticator/1Password
+
 ## GitHub Token
 
 GitHub token is required for the release process:
@@ -116,7 +126,6 @@ Sometimes You might want to test your changes on the website for example on the
 Pre-release publishes a new version to NPM with a tag other than `latest` (the default tag).
 To publish a pre-release please follow the next steps:
 
-- commit your changes to your development branch
 - build SAPI SDK from the root of the project:
   ```sh
   make core-build
@@ -143,6 +152,8 @@ To publish a pre-release please follow the next steps:
   npm publish --tag=next
   ```
 
+  During the publish you'll asked to login/enter your OTP (Two Factor Auth Code) which you can access it using Authenticator/1Password app (for more information read [here](#npm-registry))
+
 - after the new version is published to npm, install it to your local environment specifying the new version:
 
   ```sh
@@ -195,6 +206,19 @@ consumer side. We recommend installing just
 `crypto` methods. More information about polyfill can be
 found [here](https://www.npmjs.com/package/react-native-get-random-values)
 
+## Playground
+Playground is a local environment for checking your changes and test if the implementations were correct you can access this environment locally (http://localhost:3000) by opening two terminals and running these commands in order
+
+```bash
+# watch your changes to core and create a new bundle
+make core-dev
+```
+
+```bash
+# runs the playground on http://localhost:3000
+make playground-run
+```
+
 ## Usage
 
 ### Search