Skip to content

Commit 757cd12

Browse files
committed
docs: simplify install script options in README
Instead of listing all options inline, direct users to --help flag. This reduces maintenance burden and keeps documentation in sync.
1 parent 1765847 commit 757cd12

1 file changed

Lines changed: 2 additions & 10 deletions

File tree

README.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -41,18 +41,10 @@ For non-interactive installation (useful in CI/CD environments):
4141
curl -sS https://raw.githubusercontent.com/adhocore/gronx/refs/heads/main/install.sh | sh -s -- --yes
4242
```
4343

44-
The script supports various options:
45-
- `-b, --bin-dir`: Override the installation directory (default: `/usr/local/bin`)
46-
- `-v, --version`: Install a specific version (default: latest)
47-
- `-p, --platform`: Override detected platform
48-
- `-a, --arch`: Override detected architecture
49-
- `-f, -y, --force, --yes`: Skip confirmation prompts
50-
- `-h, --help`: Display help message
51-
52-
Example with custom installation directory:
44+
The script supports several options including custom installation directory, version selection, and platform/architecture overrides. Use `--help` to see all available options:
5345

5446
```sh
55-
curl -sS https://raw.githubusercontent.com/adhocore/gronx/refs/heads/main/install.sh | sh -s -- --bin-dir ~/.local/bin --yes
47+
curl -sS https://raw.githubusercontent.com/adhocore/gronx/refs/heads/main/install.sh | sh -s -- --help
5648
```
5749

5850
## Usage

0 commit comments

Comments
 (0)