readme

README.md

@@ -1,46 +1,26 @@
-# Getting Started with Create React App
+# Jambonz Webrtc Chrome extension dialer
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+The Jambonz WebRTC Chrome Extension Dialer is an easy-to-use browser extension that enables seamless WebRTC communication. With this extension, users can initiate voice calls directly from their web browsers without requiring additional software or hardware. It leverages Jambonz's open-source platform capabilities to handle VoIP communication with high quality and reliability. This extension is perfect for those who require frequent online communications, offering a streamlined experience with quick dialing features.
 
-## Available Scripts
+## Overview of the extension
 
-In the project directory, you can run:
+<p float="left">
+  <img src="./images/dialer.png" width="100" />
+  <img src="./images/history.png" width="100" />
+  <img src="./images/settings.png" width="100" />
+</p>
 
-### `npm start`
+## How to build and install
 
-Runs the app in the development mode.\
-Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
+### Build
 
-The page will reload if you make edits.\
-You will also see any lint errors in the console.
+```
+npm run build
+```
 
-### `npm test`
+### Install
 
-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.
-
-### `npm run build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-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.
-
-### `npm run eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
-
-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.
-
-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.
-
-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.
-
-## Learn More
-
-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/).
+- Open Chrome/Egde
+- Open Extensions --> Manage Extensions
+- Choose Load Unpacked
+- Browse to dist folder which is the result of npm run build command.