Update README.md

Author: amitjimiwal

README.md

@@ -1,2 +1,109 @@
+<h1 align="center" id="title">TypeSight</h1>
 
-# TypeSight
+<p align="center"><img src="https://socialify.git.ci/amitjimiwal/TypeSight/image?description=1&amp;descriptionEditable=TypeSight%3A%20The%20Typing%20Test%20with%20Eye%20Detection&amp;language=1&amp;name=1&amp;owner=1&amp;pattern=Signal&amp;theme=Light" alt="project-image"></p>
+
+<p id="description">TypeSight the premier destination for typing speed and accuracy tests. Whether you’re a professional typist or just looking to improve your skills we’ve got you covered.</p>
+
+  
+  
+<h2>🧐 Features</h2>
+
+Here're some of the project's best features:
+
+*   Accurate Results
+*   Increased Typing Accuracy
+*   Detailed Reports
+
+  
+<h2>🚀 Demo Video</h2>
+
+https://github.com/amitjimiwal/TypeSight/assets/90555965/401d1f45-c31d-4d97-8c22-890f6b7504c9
+
+
+
+
+<h2>🛠️ Installation Steps:</h2>
+
+<p>1. Clone the repository</p>
+
+```
+git clone https://github.com/amitjimiwal/TypeSight
+```
+
+<p>2. Since we are using submodules for integrating backend and the eyedetection you need to run the following command</p>
+
+```
+git submodule init 
+```
+
+<p>3. Update the submodules with the latest commit</p>
+
+```
+git submodule update
+```
+
+<p>4. Start backend server</p>
+
+```
+cd sight-backend/
+```
+
+<p>5. Go through <code>env.sample</code> file ,create a <code>.env.local</code> file and add all the corresponding environment variables in your local setup.</p>
+
+<p>6. Start the application</p>
+
+```
+npm install && npm run dev 
+```
+
+<p>7. Setup the Eye Detection</p>
+
+```
+cd EyeDirection/
+```
+
+<p>8. Install the requirements.txt</p>
+
+```
+pip install requirements.txt
+```
+
+<p>9. Start the websocket server</p>
+
+```
+python server.py
+```
+
+<p>10. Start the Frontend</p>
+
+```
+ cd ../
+```
+
+<p>11. Go through <code>env.sample</code> file ,create a <code>.env.local</code> file and add all the corresponding environment variables in your local setup.</p>
+
+<p>12. Start the application</p>
+
+```
+npm install && npm run dev 
+```
+
+  
+  
+<h2>💻 Built with</h2>
+
+Technologies used in the project:
+
+*   React
+*   Express
+*   Mediapipe
+*   OpenCV
+*   Websockets
+*   Typescript
+
+<h2>🛡️ License:</h2>
+
+This project is licensed under the The ReadLogs Project is licensed under the [MIT License](https://opensource.org/licenses/MIT). Feel free to use modify and distribute the software as per the terms of the license.
+
+<h2>💖Like my work?</h2>
+Give a ⭐️ to this repository. Thank you for taking an interest! If you encounter any issues have suggestions or want to report a bug feel free to create an issue on the repository . Happy Coding!