Skip to content

Commit

Permalink
some readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
dxrcy committed Dec 1, 2023
1 parent 5b0cf5a commit 96b7580
Showing 1 changed file with 4 additions and 15 deletions.
19 changes: 4 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Concurrently download every Garfield comic to date.

## Binary

[Download latest release](https://github.com/darccyy/everygarf/releases/latest) (portable executable)
[Download latest release](https://github.com/darccyy/everygarf/releases/latest) (executable)

## Cargo (from source)

Expand All @@ -32,21 +32,14 @@ cargo install --path everygarf

# Usage

Help information

```sh
# Help information
everygarf --help
```

Download to default folder ('garfield' in user pictures directory)

```sh
# Download to default folder ('garfield' in user pictures directory)
everygarf
```

Change some options

```sh
# Change some options
everygarf ~/Pictures/garfield -rq --attempts 20 --timeout 30
```

Expand Down Expand Up @@ -77,16 +70,12 @@ More concurrent jobs = faster overall download speed, but more CPU usage, and mo

## Proxy service

**TODO**

Default proxy url is `https://proxy.darcy-700.worker.dev`, a simple Cloudflare worker.

### Setup a custom proxy service with Cloudflare worker

Setup a Cloudflare worker with [https://github.com/Zibri/cloudflare-cors-anywhere](Zibri/cloudflare-cors-anywhere), and pass in the url with `--proxy`.

**TODO**

### Disable proxy

Use `--no-proxy` argument.
Expand Down

0 comments on commit 96b7580

Please sign in to comment.