Skip to content

Commit dc3a4b8

Browse files
committed
Chore: Modified README with elaborate description and setup instructions
1 parent 67cc2ef commit dc3a4b8

File tree

1 file changed

+31
-7
lines changed

1 file changed

+31
-7
lines changed

README.md

Lines changed: 31 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,39 @@
11
# Competitor Analysis
22

3-
This repository contains a system for analyzing competitors using data from various sources like Google, Wikipedia, and Reddit. It dynamically generates SWOT analyses and PDF reports.
3+
This repository contains a system for analyzing competitors using data from various sources like Google, Wikipedia, and Reddit. It dynamically generates SWOT analyses and PDF reports using advanced AI-driven techniques.
44

55
## Features
66

7-
- Multi-source data integration.
8-
- SWOT analysis generation using AI.
9-
- PDF reporting.
7+
- **Multi-Source Data Integration**:
8+
Aggregates data from Google Search, Wikipedia, and Reddit.
9+
- **AI-Driven SWOT Analysis**:
10+
Uses state-of-the-art LLMs (e.g., [Llama-2](https://github.com/FardinHash/competitor-analysis/tree/llama2)) to extract insights and generate SWOT analyses.
11+
- **Automated PDF Reporting**:
12+
Produces professional reports summarizing the analysis.
13+
- **Modular Multi-Agent System**:
14+
Designed for scalability and easy extensibility.
15+
16+
---
1017

1118
## Setup
1219

13-
- Clone the repository.
14-
- Install dependencies using `pip install -r requirements.txt`.
15-
- Add following API keys in the `.env` file.
20+
### 1. Clone the Repository
21+
```bash
22+
git clone git@github.com:FardinHash/competitor-analysis.git
23+
cd competitor-analysis
24+
```
25+
26+
### 2. Create a Virtual Environment
27+
```bash
28+
python3 -m venv venv
29+
source venv/bin/activate # On Windows: .\venv\Scripts\activate
30+
```
31+
32+
### 3. Install Dependencies
33+
```bash
34+
pip install -r requirements.txt
35+
```
36+
---
37+
38+
## License
39+
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)