chore: Update installation instructions with support for different modes

claswh · Jun 29, 2024 · b58af33 · b58af33
1 parent 940df46
commit b58af33
Showing 1 changed file with 38 additions and 38 deletions.
diff --git a/docs/md/installation.md b/docs/md/installation.md
@@ -9,49 +9,49 @@ There are three ways to use Crawl4AI:
 
 Crawl4AI offers flexible installation options to suit various use cases. Choose the option that best fits your needs:
 
-1. **Default Installation** (Basic functionality):
-   ```bash
-   virtualenv venv
-   source venv/bin/activate
-   pip install "crawl4ai @ git+https://github.com/unclecode/crawl4ai.git"
-   ```
-   Use this for basic web crawling and scraping tasks.
+- **Default Installation** (Basic functionality):
+```bash
+virtualenv venv
+source venv/bin/activate
+pip install "crawl4ai @ git+https://github.com/unclecode/crawl4ai.git"
+```
+Use this for basic web crawling and scraping tasks.
 
-2. **Installation with PyTorch** (For advanced text clustering):
-   ```bash
-   virtualenv venv
-   source venv/bin/activate
-   pip install "crawl4ai[torch] @ git+https://github.com/unclecode/crawl4ai.git"
-   ```
-   Choose this if you need the CosineSimilarity cluster strategy.
+- **Installation with PyTorch** (For advanced text clustering):
+```bash
+virtualenv venv
+source venv/bin/activate
+pip install "crawl4ai[torch] @ git+https://github.com/unclecode/crawl4ai.git"
+```
+Choose this if you need the CosineSimilarity cluster strategy.
 
-3. **Installation with Transformers** (For summarization and Hugging Face models):
-   ```bash
-   virtualenv venv
-   source venv/bin/activate
-   pip install "crawl4ai[transformer] @ git+https://github.com/unclecode/crawl4ai.git"
-   ```
-   Opt for this if you require text summarization or plan to use Hugging Face models.
+- **Installation with Transformers** (For summarization and Hugging Face models):
+```bash
+virtualenv venv
+source venv/bin/activate
+pip install "crawl4ai[transformer] @ git+https://github.com/unclecode/crawl4ai.git"
+```
+Opt for this if you require text summarization or plan to use Hugging Face models.
 
-4. **Full Installation** (All features):
-   ```bash
-   virtualenv venv
-   source venv/bin/activate
-   pip install "crawl4ai[all] @ git+https://github.com/unclecode/crawl4ai.git"
-   ```
-   This installs all dependencies for full functionality.
+- **Full Installation** (All features):
+```bash
+virtualenv venv
+source venv/bin/activate
+pip install "crawl4ai[all] @ git+https://github.com/unclecode/crawl4ai.git"
+```
+This installs all dependencies for full functionality.
 
-5. **Development Installation** (For contributors):
-   ```bash
-   virtualenv venv
-   source venv/bin/activate
-   git clone https://github.com/unclecode/crawl4ai.git
-   cd crawl4ai
-   pip install -e ".[all]"
-   ```
-   Use this if you plan to modify the source code.
+- **Development Installation** (For contributors):
+```bash
+virtualenv venv
+source venv/bin/activate
+git clone https://github.com/unclecode/crawl4ai.git
+cd crawl4ai
+pip install -e ".[all]"
+```
+Use this if you plan to modify the source code.
 
-💡 After installation, it's recommended to run the following CLI command to load the required models. This is optional but will boost the performance and speed of the crawler. You need to do this only once:
+💡 After installation, if you have used "torch", "transformer" or "all", it's recommended to run the following CLI command to load the required models. This is optional but will boost the performance and speed of the crawler. You need to do this only once, this is only for when you install using []
 ```bash
 crawl4ai-download-models
 ```