diff --git a/README.md b/README.md index c70c8dd..c21b007 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,29 @@ - -# TEMPLATE-README + +# CrawlAI
-![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/CogitoNTNU/TEMPLATE-README/ci.yml) -![GitHub top language](https://img.shields.io/github/languages/top/CogitoNTNU/TEMPLATE-README) -![GitHub language count](https://img.shields.io/github/languages/count/CogitoNTNU/TEMPLATE-README) +![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/CogitoNTNU/CrawlAI/ci.yml) +![GitHub top language](https://img.shields.io/github/languages/top/CogitoNTNU/CrawlAI) +![GitHub language count](https://img.shields.io/github/languages/count/CogitoNTNU/CrawlAI) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Project Version](https://img.shields.io/badge/version-0.0.1-blue)](https://img.shields.io/badge/version-0.0.1-blue) -Cogito Project Logo +Cogito Project Logo
📋 Table of contents -- [TEMPLATE-README](#template-readme) +- [CrawlAI](#crawlai) - [Description](#description) - [Getting started](#getting-started) - [Prerequisites](#prerequisites) - [Usage](#usage) - [Testing](#testing) + - [Documentation](#documentation) - [Team](#team) - [License](#license) @@ -36,53 +37,85 @@ - - ### Prerequisites - +- **Python:** Programming language used to build the application [Download Python](https://www.python.org/downloads/) ---> -- Ensure that git is installed on your machine. [Download Git](https://git-scm.com/downloads) ## Usage To run the project, run the following command from the root directory of the project: ```bash - +python main.py ``` ## Testing To run the test suite, run the following command from the root directory of the project: ```bash - +pytest ``` +## Documentation +- [Developer Setup](docs/manuals/developer_setup.md) + + ## Team This project would not have been possible without the hard work and dedication of all of the contributors. Thank you for the time and effort you have put into making this project a reality. - -
diff --git a/docs/images/crawlai.webp b/docs/images/crawlai.webp new file mode 100644 index 0000000..1109632 Binary files /dev/null and b/docs/images/crawlai.webp differ