Skip to content

Commit

Permalink
docs: update README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
asciito authored Oct 21, 2023
1 parent 5c18777 commit c3bdb0c
Showing 1 changed file with 63 additions and 1 deletion.
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,71 @@ with the correct Browser Version, is painful (I **HATE** manual tasks), I decide

**I HATE MANUAL TASKS**

---

## Documentation

_Working_...
* [Commands](#commands)
* [Install Google Chrome Browser](#install-google-chrome-browser)
* [Install Google Chrome Driver](#install-google-chrome-driver)

### Commands

The two installation commands shares similar signatures, something like this:

```bash
./google-for-testing install:<browser|driver> [options]
```

There are three options available to change the way the command works.

- **`--ver=[VER]`**:
This option by default is set to `115.0.5763.0` in both commands.
> **Note**:
For the `install:driver` command, the default version it's really important, this is the started version from where you can get
the `chromedriver` binary, before that version, we don't have access to it (for now).

- **`--latest`**:
This option will download the latest version.

- **`--path=[PATH]`**:
This will let you choose where to download it.

> **Note**:
> The default location for every download is `$HOME/.google-for-testing`
<br>

#### Install Google Chrome Browser

The syntax for to install Google Chrome Browser is the next one:

```bash
./google-for-testing install:browser [options]
```

Running this command without any option, will download the default version `115.0.5763.0`, but you can choose
any other version to download (if is available).

You can check the available versions on this [API endpoint](https://googlechromelabs.github.io/chrome-for-testing/known-good-versions.json) 👈

<br>

#### Install Google Chrome Driver

The syntax for to install Google Chrome Driver is the next one:

```bash
./google-for-testing install:driver [options]
```

Running this command without any option, will download the default version `115.0.5763.0`, but you can choose
any other version to download (if is available).

> **Note**: You can check the available versions on this [API endpoint](https://googlechromelabs.github.io/chrome-for-testing/known-good-versions.json) 👈, but keep in mind
> that for `chromedriver` the versions starts at `115.0.5763.0`, so any version below that we will not have access to the binary download link (for now).
---

## License

Expand Down

0 comments on commit c3bdb0c

Please sign in to comment.