updated Readme

README.md

@@ -10,64 +10,89 @@ pinned: false
 license: apache-2.0
 ---
 # CrewAI
-CrewAI
+Certainly! Below is a sample README file for CrewAI. Feel free to adjust the content based on the specifics of your project.
+
+---
+
+# CrewAI
+
 CrewAI is an advanced AI-driven platform designed to streamline and enhance team collaboration and project management. Leveraging state-of-the-art machine learning algorithms, CrewAI offers intelligent features to boost productivity and efficiency within teams.
 
-Table of Contents
-Getting Started
-Features
-Installation
-Usage
-Contributing
-License
-Important Links and References
-Getting Started
+## Table of Contents
+- [Getting Started](#getting-started)
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+- [Important Links and References](#important-links-and-references)
+
+## Getting Started
+
 These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.
 
-Prerequisites
+### Prerequisites
+
 Ensure you have the following software installed on your machine:
 
-Python 3.8+
-pip (Python package installer)
-Installation
-Clone the repository:
-
-sh
-git clone https://github.com/yourusername/CrewAI.git
-cd CrewAI
-Install the required packages:
-
-sh
-pip install -r requirements.txt
-Features
-Task Management: Create, assign, and track tasks within your team.
-Collaboration Tools: Communicate and share files seamlessly.
-AI Insights: Receive intelligent insights and recommendations based on project data.
-Analytics: Monitor project progress with detailed analytics and reports.
-Usage
+- Python 3.8+
+- pip (Python package installer)
+
+### Installation
+
+1. Clone the repository:
+    ```sh
+    git clone https://github.com/aitiwari/CrewAI.git
+    cd CrewAI
+    ```
+
+2. Install the required packages:
+    ```sh
+    pip install -r requirements.txt
+    ```
+
+## Features
+
+- **Task Management:** Create, assign, and track tasks within your team.
+- **Collaboration Tools:** Communicate and share files seamlessly.
+- **AI Insights:** Receive intelligent insights and recommendations based on project data.
+- **Analytics:** Monitor project progress with detailed analytics and reports.
+
+## Usage
+
 To start the application, run:
 
-sh
-python app.py
-Visit http://localhost:5000 in your web browser to access the application.
-
-Contributing
-We welcome contributions from the community! Please read our Contributing Guide for details on our code of conduct, and the process for submitting pull requests.
-
-License
-This project is licensed under the MIT License - see the LICENSE file for details.
-
-Important Links and References
-Project Repository: GitHub
-Documentation: Docs
-Issue Tracker: GitHub Issues
-Discussion Forum: Community Forum
-API Reference: API Docs
-Contributing Guide: Contributing
-Changelog: Changelog
-Acknowledgments
-Special thanks to all contributors and the open-source community.
-Inspiration and support from our user base.
+```sh
+streamlit run app.py
+```
+
+Visit `http://localhost:8501/` in your web browser to access the application.
+
+## Contributing
+
+We welcome contributions from the community! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Important Links and References
+
+- **Project Repository:** [GitHub](https://github.com/aitiwari/CrewAI)
+- **Documentation:** [Docs](https://github.com/crewAIInc/crewAI)
+
+## Acknowledgments
+
+- Special thanks to all contributors and the open-source community.
+- Inspiration and support from our user base.
+
+## Screeshot
+![crewaidemo](image.png)
+
+---
+
 Feel free to reach out if you have any questions or need further assistance. Happy coding!
 
- 
+---
+
+This README covers the essential aspects of CrewAI, providing clear instructions for setup, usage, and contribution, along with links to important resources.