fix(added readme.md files): added readme.md files

opensrc0 · Mar 20, 2024 · 45cbc0b · 45cbc0b
1 parent 9e468e6
commit 45cbc0b
Show file tree

Hide file tree

Showing 9 changed files with 81 additions and 8 deletions.
diff --git a/__app/component/AutoFillOtp/README.md b/__app/component/AutoFillOtp/README.md
@@ -1 +0,0 @@
-

diff --git a/__app/component/CopyToClipboard/README.md b/__app/component/CopyToClipboard/README.md
@@ -55,7 +55,7 @@ const successCb = ({ msgType, msg, data }) => {
 />
 ```
 > [!Note]
- Define **successCb** fn and your will get an object in param contains the property ```msgType```, ```msg```, ```data```
+> Define **successCb** fn and your will get an object in param contains the property ```msgType```, ```msg```, ```data```
 
 ## 3. Failure CallBack Fn along with failure msg
 ```js

diff --git a/__app/component/LiveLocationTracking/README.md b/__app/component/LiveLocationTracking/README.md
@@ -1 +1,13 @@
+## 1. Happy Flow 
+
+#### a) Provide mandatory fields
+```js
+<LiveLocationTracking 
+  googleKey="AIzaSyCimWLcCkTc03jZrTE6TxfTH0PauR2Keps" 
+  isProdKey={false} 
+  destinationLatLng={{ lat: 12.9541033, lng: 77.7091133 }}
+/>
+```
+> [!Note]
+> Passing production googleKey require to pass isProdKey as a true.
 
diff --git a/__app/component/LocateMe/README.md b/__app/component/LocateMe/README.md
@@ -1,6 +1,20 @@
 1. sudo vim /etc/hosts
-2. 127.0.0.1       beta.reliancedigital.live
+2. 127.0.0.1       beta.mysite.live
 3. chrome://net-internals/#hsts
-4. delete beta.reliancedigital.live
+4. delete beta.mysite.live
 5. chrome://flags/#unsafely-treat-insecure-origin-as-secure
-6. add domain [beta.reliancedigital.live](http://beta.reliancedigital.live:9003)
+6. add domain [beta.mysite.live](http://beta.mysite.live:9003)
+
+## 1. Happy Flow 
+
+#### a) Provide mandatory fields
+```js
+<LocateMe 
+  googleKey="AIzaSyCimWLcCkTc03jZrTE6TxfTH0PauR2Keps" 
+  isProdKey={false}
+>
+  Locate Me
+</LocateMe>
+```
+> [!Note]
+> Passing production googleKey require to pass isProdKey as a true.
diff --git a/__app/component/LocateMe/Readme.md b/__app/component/LocateMe/Readme.md
@@ -1,6 +1,20 @@
 1. sudo vim /etc/hosts
-2. 127.0.0.1       beta.reliancedigital.live
+2. 127.0.0.1       beta.mysite.live
 3. chrome://net-internals/#hsts
-4. delete beta.reliancedigital.live
+4. delete beta.mysite.live
 5. chrome://flags/#unsafely-treat-insecure-origin-as-secure
-6. add domain [beta.reliancedigital.live](http://beta.reliancedigital.live:9003)
+6. add domain [beta.mysite.live](http://beta.mysite.live:9003)
+
+## 1. Happy Flow 
+
+#### a) Provide mandatory fields
+```js
+<LocateMe 
+  googleKey="AIzaSyCimWLcCkTc03jZrTE6TxfTH0PauR2Keps" 
+  isProdKey={false}
+>
+  Locate Me
+</LocateMe>
+```
+> [!Note]
+> Passing production googleKey require to pass isProdKey as a true.
diff --git a/__app/component/PhoneBook/README.md b/__app/component/PhoneBook/README.md
@@ -1 +1,5 @@
+## 1. Happy Flow 
 
+```js
+<PhoneBook />
+```
diff --git a/__app/component/Share/README.md b/__app/component/Share/README.md
@@ -1 +1,6 @@
 
+## 1. Happy Flow 
+
+```js
+<Share />
+```
diff --git a/__app/component/TextToSpeech/README.md b/__app/component/TextToSpeech/README.md
@@ -1 +1,15 @@
+## 1. Happy Flow 
 
+```js
+<VoiceRecognitionInit>
+  <VoiceRecognitionIcon>
+    Voice Icon
+  </VoiceRecognitionIcon>
+  <VoiceRecognitionModal>
+    <div>Voice Modal</div>
+  </VoiceRecognitionModal>
+</VoiceRecognitionInit>
+```
+
+
+
diff --git a/__app/component/VoiceRecognition/README.md b/__app/component/VoiceRecognition/README.md
@@ -1 +1,12 @@
 
+## 1. Happy Flow 
+
+```js
+<TextToSpeech.Init text="Password field is not contained in a form: (More info: ">
+  <TextToSpeech.Start>TextToSpeech-Start</TextToSpeech.Start>
+  <TextToSpeech.Stop>TextToSpeech-Stop</TextToSpeech.Stop>
+</TextToSpeech.Init>
+```
+
+
+