ROADMAP.md + edits

Signed-off-by: thisisankit27 <[email protected]>

CONTRIBUTING.md

@@ -10,7 +10,7 @@ Thank you for considering contributing to SnapSpeak! We appreciate your interest
 
 - Contributing Code: To contribute code to SnapSpeak, follow these steps:
   1. Fork the repository to your GitHub account.
-  2. Create a new branch from the `main` branch for your changes.
+  2. Create a new branch from the `master` branch for your changes.
   3. Make your desired changes and ensure they adhere to the project's coding standards.
   4. Test your changes thoroughly.
   5. Commit your changes and create a clear, descriptive pull request (PR) explaining the purpose of your changes.

README.md

@@ -1,6 +1,12 @@
-# SnapSpeak - Visual Elocution Synthesis
+# SnapSpeak - Redefining Visual Storytelling
 
+SnapSpeak is your go-to platform for transforming images into captivating narratives. Our user-friendly interface allows for seamless image uploads, drag-and-drop functionality, and on-the-go capture using the Media Stream API. Choose between our Image Caption Generator or OCR for versatile text extraction.
 
+Behind the scenes, our server processes images with precision, employing advanced techniques like py-tesseract OCR and a finely tuned model trained on the Flickr30K dataset. 
+
+The future of SnapSpeak is bright. We're expanding with MongoDB integration for image storage, Docker deployment, and scaling on Digital Ocean's Kubernetes. Jenkins ensures a smooth development pipeline.
+
+Join us in revolutionizing visual communication with SnapSpeak. Let your images do the talking.
 
 ## Windows Installation
 

ROADMAP.md

@@ -0,0 +1,37 @@
+# SnapSpeak Roadmap
+
+Welcome to SnapSpeak's roadmap! This document provides an overview of our future plans and development milestones. We're excited to share our vision for the evolution of SnapSpeak with you.
+
+## Short-Term Goals (Next 3-6 Months)
+
+- **MongoDB Integration**: Integrate MongoDB for efficient storage and retrieval of images, enhancing scalability and performance.
+- **NGINX Integration**: Utilize NGINX for serving static files, improving server performance and reliability.
+- **Kubernetes Deployment**: Explore deployment on Digital Ocean's Kubernetes for automated scaling and high availability.
+- **Continuous Integration with Jenkins**: Implement Jenkins for automated testing and continuous integration, streamlining development workflows.
+
+## Medium-Term Goals (6-12 Months)
+
+- **Enhanced Image Processing**: Implement advanced image processing techniques to improve the accuracy and efficiency of text extraction.
+- **Optimization**: Fine-tune server performance and optimize resource utilization for better scalability.
+- **Improved User Experience**: Continuously iterate on the frontend to enhance user experience and streamline workflows.
+- **Integration Testing**: Implement comprehensive integration testing to ensure robustness and reliability across all components.
+
+## Long-Term Goals (Beyond 12 Months)
+
+- **Machine Learning Enhancements**: Explore advanced machine learning techniques to further improve the accuracy and capabilities of the visual elocution synthesis model.
+- **Community Engagement**: Foster a vibrant community around SnapSpeak, encouraging collaboration, feedback, and contributions from users and developers.
+- **Accessibility Features**: Implement accessibility features to ensure inclusivity and usability for users with disabilities.
+- **Localization**: Expand language support and localization efforts to make SnapSpeak accessible to users worldwide.
+- **AI-driven Insights**: Develop AI-driven insights and analytics to provide users with valuable insights into their visual content.
+
+## Get Involved
+
+We welcome contributions from the community to help us achieve our roadmap goals and shape the future of SnapSpeak. Whether you're a developer, designer, or enthusiast, there are many ways to get involved:
+
+- **Contribute Code**: Check out our [contribution guidelines](CONTRIBUTING.md) and contribute code to help us implement new features and enhancements.
+- **Report Issues**: If you encounter any bugs or have suggestions for improvements, [open an issue](https://github.com/thisisankit27/SnapSpeak/issues) on GitHub to let us know.
+- **Spread the Word**: Share SnapSpeak with your friends, colleagues, and networks to help us grow and reach more users.
+- **Provide Feedback**: We value your feedback! Let us know what you think about SnapSpeak and how we can make it even better.
+
+Together, we can continue to innovate and redefine the future of visual storytelling with SnapSpeak.
+