@hopara/iframe 0.2.3 → 0.2.5

package/README.md

@@ -2,7 +2,7 @@
 This package provides an iframe to add [Hopara](https://hopara.io) visualizations to your project.
 
 # Installing
-You can install it as a NPM module or using Hopara CDN directly:
+You can install the iframe as a NPM module or using the Hopara CDN directly:
 
 As a module:
 ```shell
@@ -15,7 +15,7 @@ Using Hopara CDN:
 ```
 
 ## Authentication
-The iframe requires a valid `accessToken`. Use the `Auth API` to fetch it, as explained in our [integration guide](https://docs.hopara.app/docs/integration-guide/authentication-integration.html)
+The iframe requires a valid `accessToken`. Use the `Auth API` to fetch it, as explained in our [integration guide](https://docs.hopara.app/#/docs/integration-guide/2-authentication-integration.html)
 
 # Example
 ### Node.JS
@@ -109,8 +109,8 @@ type DataLoader = {
 
 #### Example
 
-```jsx
-const dataLoaders = [{
+```javascript
+const customDataLoaders = [{
   name: 'queryName',
   source: 'dataSourceName',
   loader: () => {
@@ -139,13 +139,13 @@ const dataLoaders = [{
     ]
   }
 }]
-...
-<div className="HoparaEmbedded">
-  <Hopara
-    app="your-app-id"
-    accessToken="your-access-token"
-    dataLoaders={dataLoaders}
-  />
+
+Hopara.init({
+  app: 'my-hopara-app',
+  accessToken: 'my-hopara-token',
+  targetElementId: 'my-target-element',
+  dataLoaders: customDataLoaders,
+})
 ```
 
 ### Data Updater
@@ -167,7 +167,7 @@ type DataUpdater = {
 ```
 
 ```jsx
-const dataUpdaters = [{
+const customDataUpdaters = [{
   name: 'queryName',
   source: 'dataSourceName',
   updater: (newRow) => {
@@ -176,15 +176,13 @@ const dataUpdaters = [{
   }
 }]
 
-...
 
-<div className="HoparaEmbedded">
-  <Hopara
-    app="your-app-id"
-    accessToken="your-access-token"
-    dataUpdaters={dataUpdaters}
-  />
-</div>
+Hopara.init({
+  app: 'my-hopara-app',
+  accessToken: 'my-hopara-token',
+  targetElementId: 'my-target-element',
+  dataUpdaters: customDataUpdaters,
+})
 ```
 
 ### Initial Position

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hopara/iframe",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "main": "build/client.js",
   "scripts": {
     "start": "ESLINT_NO_DEV_ERRORS=true react-app-rewired start",
@@ -27,8 +27,8 @@
   ],
   "devDependencies": {
     "@babel/register": "^7.15.3",
-    "@hopara/react": "^0.2.3",
-    "@hopara/system-test": "^0.2.3",
+    "@hopara/react": "^0.2.5",
+    "@hopara/system-test": "^0.2.4",
     "babel-loader": "8.1.0",
     "customize-cra": "^1.0.0",
     "react": "^18.2.0",