feat: improved user documentation (#7)

* Revert "feat: improved user documentation (#6)"

This reverts commit fec4c09.

* feat: corrected ci steps

.github/workflows/ci.yml

@@ -39,13 +39,15 @@ jobs:
     #     ENDPOINT: https://deploy-preview-${{github.event.number}}--ambianic-serverless.netlify.app/.netlify/functions
 
     - name: Wait for successful preview deployment
+      if: ${{ github.event_name == 'pull_request' }}
       uses: jakepartusch/wait-for-netlify-action@v1
       id: get-netlify-url
       with:
         site_name: "ambianic-serverless"
         max_timeout: 60
 
     - name: Run tests against deployed preview
+      if: ${{ github.event_name == 'pull_request' }}
       run:  npm run test:postman
       env:
         STRIPE_TEST_KEY: ${{ secrets.STRIPE_TEST_KEY }}
@@ -69,7 +71,7 @@ jobs:
     - name: Run the semantic-release
       run: npx semantic-release
       env:
-        GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
     - name: Code Coverage Report

README.md

@@ -7,7 +7,7 @@
 The image below shows the architecture of these serverless functions in connection with the Ambianic [PWA](https://github.com/ambianic/ambianic-ui/).
 ![serverless-functions-architecture](./assets/serverless-architecture.png)
 
-## Local Development / Usage
+## Running Locally
 
 The serverless functions within this project are managed using [netlify-dev](https://www.netlify.com/products/dev/). Start the functions emulator from the `netlify` directory using `yarn netlify-dev` to listen for requests to any of created functions on port `5050`.
 

package.json

@@ -48,8 +48,9 @@
     "ci": false,
     "branches": [
       "main",
+      "master",
       "docs/swagger",
-      "development"
+      "documentation"
     ],
     "plugins": [
       "@semantic-release/commit-analyzer",