Skip to content

Update README for mlx-crawler version to 0.0.2 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BrandonWeng merged 1 commit into from
Oct 18, 2025
Merged

Update README for mlx-crawler version to 0.0.2 #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,15 +34,15 @@ If you're not on [`uv`](https://docs.astral.sh/uv/getting-started/installation/)
### Run without installing with `uvx`

```bash
uvx --from git+https://github.com/FluidInference/mlx-crawler.git@v0.0.1 mlx-crawler --help
uvx --from git+https://github.com/FluidInference/mlx-crawler.git@v0.0.2 mlx-crawler --help
```

`uvx` (an alias for `uv tool run`) clones the repository into uv's cache, builds it, and launches the `mlx-crawler` entry point—handy for trying the pipelines without installing anything permanently.

### Install as a uv tool

```bash
uv tool install --from git+https://github.com/FluidInference/mlx-crawler.git@v0.0.1 mlx-crawler
uv tool install --from git+https://github.com/FluidInference/mlx-crawler.git@v0.0.2 mlx-crawler

uv tool run mlx-crawler -- crawl https://ml-explore.github.io/mlx/build/html/index.html --output output/mlx-docs --verbose

Expand Down