From 4a4f613238165bb8c330a044b0df9a146c5041dc Mon Sep 17 00:00:00 2001 From: UncleCode Date: Wed, 1 Jan 2025 16:54:03 +0800 Subject: [PATCH] docs: simplify installation instructions - Add crawl4ai-doctor command to verify installation - Update browser installation instructions in README and docs - Move optional features to documentation - Add manual browser installation steps as fallback - Update getting-started guide with verification step --- README.md | 12 ++++++++---- docs/md_v3/tutorials/getting-started.md | 9 ++++++++- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0a56a397..94b06250 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,17 @@ Crawl4AI is the #1 trending GitHub repository, actively maintained by a vibrant ```bash # Install the package pip install crawl4ai + +# Run post-installation setup crawl4ai-setup -# Install Playwright with system dependencies (recommended) -playwright install --with-deps +# Verify your installation +crawl4ai-doctor +``` -# Or install specific browsers: -playwright install --with-deps chrome # Recommended for Colab/Linux +If you encounter any browser-related issues, you can install them manually: +```bash +python -m playwright install --with-deps chrome chromium ``` 2. Run a simple web crawl: diff --git a/docs/md_v3/tutorials/getting-started.md b/docs/md_v3/tutorials/getting-started.md index 045590cb..b148e6e1 100644 --- a/docs/md_v3/tutorials/getting-started.md +++ b/docs/md_v3/tutorials/getting-started.md @@ -31,7 +31,14 @@ By the end of this guide, you’ll have installed Crawl4AI, performed a basic cr ```bash pip install crawl4ai crawl4ai-setup -playwright install --with-deps + +# Verify your installation +crawl4ai-doctor +``` + +If you encounter any browser-related issues, you can install them manually: +```bash +python -m playwright install --with-deps chrome chromium ``` - **`crawl4ai-setup`** installs and configures Playwright (Chromium by default).