ayrisdev/crawl4ai
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore: Update .gitignore and README.md

Browse Source
This commit is contained in:
unclecode
2024-05-09 19:25:25 +08:00
parent 898ec30a18
commit c71adb29ce
3 changed files with 5 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -162,4 +162,5 @@ cython_debug/
#.idea/ #.idea/
Crawl4AI.egg-info/ Crawl4AI.egg-info/
Crawl4AI.egg-info/* Crawl4AI.egg-info/*
crawler_data.db

7
README.md
View File

@@ -55,10 +55,7 @@ git clone https://github.com/unclecode/crawl4ai.git
cd crawl4ai cd crawl4ai
``` ```
3. Create a `.env` file in the root folder and set your Groq API token: 3. Open `crawler/config.py` and set your favorite LLM provider and API token:
```
GROQ_API_TOKEN=your_groq_api_token
```
4. Build the Docker image: 4. Build the Docker image:
``` ```
@@ -71,7 +68,7 @@ docker build --platform linux/amd64 -t crawl4ai .
5. Run the Docker container: 5. Run the Docker container:
``` ```
docker run -p 8000:80 crawl4ai docker run -d -p 8000:80 crawl4ai
``` ```
6. Access the application at `http://localhost:8000`. 6. Access the application at `http://localhost:8000`.

18
pages/index.html
View File

@@ -196,23 +196,7 @@
<div class="container mx-auto px-4"> <div class="container mx-auto px-4">
<h2 class="text-2xl font-bold mb-4">⚙️ Installation</h2> <h2 class="text-2xl font-bold mb-4">⚙️ Installation</h2>
<p class="mb-4"> <p class="mb-4">
To install and run Crawl4AI locally or on your own service, the best way is to use Docker. 🐳 Follow To install and run Crawl4AI as a library or a local server, please refer to the 📚
these steps:
</p>
<ol class="list-decimal list-inside mb-4">
<li>
Clone the GitHub repository: 📥
<code>git clone https://github.com/unclecode/crawl4ai.git</code>
</li>
<li>Navigate to the project directory: 📂 <code>cd crawl4ai</code></li>
<li>
Build the Docker image: 🛠️ <code>docker build -t crawl4ai .</code> On Mac, follow: 🍎
<code>docker build --platform linux/amd64 -t crawl4ai .</code>
</li>
<li>Run the Docker container: ▶️ <code>docker run -p 8000:80 crawl4ai</code></li>
</ol>
<p>
For more detailed instructions and advanced configuration options, please refer to the 📚
<a href="https://github.com/unclecode/crawl4ai" class="text-blue-400">GitHub repository</a>. <a href="https://github.com/unclecode/crawl4ai" class="text-blue-400">GitHub repository</a>.
</p> </p>
</div> </div>