Readme Updated

readme.md

@@ -1 +1,76 @@
-# Youtube Video Timestamp Extension
+# YouTube Video Timestamp Extension
+
+## Overview
+
+YouTube Video Timestamp Extension is a Chrome extension developed by Pritam0011 using React. It enables users to bookmark specific timestamps within YouTube videos for future reference. Additionally, the extension provides a convenient email-sharing feature for sharing bookmarks with others. Notably, the extension does not require users to log in or provide any credentials, ensuring a hassle-free experience.
+
+## Features
+
+- **Bookmarking:** Allows users to bookmark specific timestamps within YouTube videos.
+- **Email Sharing:** Enables users to share bookmarks via email with others.
+- **No Credentials Required:** Provides a seamless experience without the need for user authentication or login.
+- **React-based UI:** Utilizes React for a modern and responsive user interface.
+
+## Support API
+
+The email-sharing feature of the YouTube Video Timestamp Extension relies on a support API for email sending. The support API, named [YouTube Timestamp Support](https://github.com/Pritam0011/yt-timestamp-support), provides the necessary backend infrastructure for handling email requests and facilitating seamless communication between the extension and email servers.
+
+## Installation
+
+To install the YouTube Video Timestamp Extension as a Chrome extension, follow these steps:
+
+1. Download the extension zip file from the [latest release](https://github.com/Pritam0011/youtube-video-timestamp-extension/releases/latest).
+
+2. Extract the contents of the zip file to a folder on your computer.
+
+3. Open Google Chrome.
+
+4. Navigate to `chrome://extensions/` in the address bar.
+
+5. Enable "Developer mode" in the top right corner of the page.
+
+6. Click on the "Load unpacked" button.
+
+7. Select the folder where you extracted the extension files.
+
+8. The extension should now be installed and visible in your Chrome browser toolbar.
+
+## Usage
+
+Once installed, the YouTube Video Timestamp Extension can be used to bookmark timestamps within YouTube videos and share them via email. Here's how to use the extension:
+
+1. Navigate to a YouTube video in Google Chrome.
+
+2. While watching the video, pause at the desired timestamp you want to bookmark.
+
+3. Click on the "Pin" icon, showing in the video controls section to save the timestamp.
+
+4. Click on the extension icon in the Chrome toolbar to open the extension popup.
+
+5. To play the video at a bookmarked timestamp click on the timestamp.
+
+6. To share all bookmark via email, click on the "Share" button and enter the recipient's email address.
+
+7. The recipient will receive an email containing the shared bookmarks.
+
+## Inspiration and Learning
+
+This project drew inspiration and learning from the YouTube channel [freeCodeCamp.org](https://www.youtube.com/channel/UC8butISFwT-Wl7EV0hUK0BQ), particularly under the instruction of Raman Hundal. Raman Hundal is a professional Chrome extension developer known for his expertise in developing browser extensions using modern web technologies. His tutorials and insights provided valuable guidance and inspiration throughout the development process of the YouTube Video Timestamp Extension.
+
+## Contributing
+
+Contributions to the YouTube Video Timestamp Extension project are welcome! To contribute:
+
+1. Fork the repository.
+
+2. Create a new branch for your feature or bug fix.
+
+3. Make your changes and ensure tests pass.
+
+4. Commit your changes and push to your fork.
+
+5. Submit a pull request with a detailed description of your changes.
+
+## License
+
+This project is licensed under the MIT License.