@myinterview/widget-react 1.0.0 → 1.0.1

package/README.md

@@ -1,46 +1,58 @@
-# Getting Started with Create React App
+# React-Widget
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+The myInterview widget for [React](https://reactjs.com). 
 
-## Available Scripts
+See [myinterview.com](https://www.myinterview.com) for an examples and comprehensive docs.
 
-In the project directory, you can run:
+# Installation and usage
 
-### `npm start`
+The easiest way to use react-widget is to install it from npm and build it into your app with Webpack / rollup / parcel.
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+>react-widget compatible with react version `react@16.x.x`, `react@17.x.x`, `react@18.x.x`!
 
-### `npm test`
+```bash
+yarn add @myinterview/widget-react
 
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
+# or use npm
 
-### `npm run build`
+npm install @myinterview/widget-react
+```
 
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
+Then use it in your app:
 
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
 
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
+```jsx
+import React from 'react';
+import { Widget } from '@myinterview/widget-react';
 
-### `npm run eject`
+const App = () => {
+    const onCompleteCallback = () => {
+        //...
+    }
+    const onError = () => {
+        // ...
+    }
+    return (
+        // ...
+        <Widget
+            job={{ job_id: "xxxxxxxxxxxxxxxxxx" }}
+            candidate={{ email: "test@mail.com", username: "Max" }}
+            config={{ onCompleteCallback, onError,
+                auth: "apikey xxxxxxxxxxxxxxxxx sig=xxxxxxxxxxxxxxxxxxxxxxxxxx" }}
+        />
+    )
+}
+```
 
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
+# Documentation
 
-If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
+> **For more detailed documentation with all explanation about possible (Props, Methods and Customisation ) please visit your website [myinterview.com](https://www.myinterview.com)**
 
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
+# Thanks
 
-You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
+Just want to say thank you to everyone who has made it happen. 
 
-## Learn More
+## License
 
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
+MIT Licensed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@myinterview/widget-react",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "myInterview widget v3",
   "module": "dist/esm/index.js",
   "files": [