Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rishiraj authored Sep 22, 2024
1 parent 0e5bbac commit 4bc7154
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ pip install firerequests

Accelerate your downloads with just a few lines of code:

### Python Usage

```python
from firerequests import FireRequests

Expand All @@ -34,6 +36,18 @@ fr = FireRequests()
fr.download(url, filename)
```

### Command Line Interface

```bash
!firerequests https://mirror.clarkson.edu/zorinos/isos/17/Zorin-OS-17.2-Core-64-bit.iso --filename Zorin-OS-17.2-Core-64-bit.iso
```

#### Parameters:
- `url` (required): The URL to download the file from.
- `--filename` (optional): The name to save the downloaded file. Defaults to filename from URL.
- `--max_files` (optional): The number of concurrent file chunks. Defaults to 10.
- `--chunk_size` (optional): The size of each chunk in bytes. Defaults to `2 * 1024 * 1024` (2 MB).

## Real-World Speed Test 🏎️

FireRequests delivers significant performance improvements over traditional download methods. Below is the result of a real-world speed test:
Expand Down

0 comments on commit 4bc7154

Please sign in to comment.