Skip to content

Commit 7df1d22

Browse files
Update README.md
1 parent 6f94022 commit 7df1d22

File tree

1 file changed

+37
-13
lines changed

1 file changed

+37
-13
lines changed

README.md

+37-13
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,43 @@
1414

1515
## Description
1616

17-
Updater for applications from GitHub. It has a huge number of convenient settings and it supports multiple downloaders, and can also download files not from GitHub based only on the release.
18-
19-
## Features (version 2.2)
20-
21-
- Features of fine-tuning the update process, a huge number of arguments for incredibly fine-tuning asset downloads from GitHub and beyond...
22-
- Support for releases without assets, the file itself will be downloaded from another site via a direct link ([example](https://github.com/Zalexanninev15/GRU#example-visual-studio-code))
23-
- Using, at the user's choice, as many as three types of downloader: **curl**, **wget**, **gru**.
24-
- Using the console **7-Zip** allows you to unpack almost all kinds of release archives.
25-
- Automatically kill the process of the updated application when updating, which eliminates possible difficulties when updating applications that are already running.
26-
- Support for a custom script that runs after an application update (`script.bat` file).
27-
- Clear and sufficiently self-sufficient documentation (run `gru.exe` without arguments).
28-
- Support for determining the current version when using a specific argument for a more fine-grained application update process.
29-
- Automatically cleans all temporary files after its work (there may be problems with some, but in most cases everything goes fine).
17+
Updater for applications from GitHub. It has a huge number of convenient settings and supports multiple rockers, and can download files not only from GitHub, but also based only on the release, supports pre-releases and a fairly deep asset search among releases. Lots of arguments.
18+
19+
## Features
20+
21+
- **Fine-Grained Update Customization**: Highly customizable asset download process with numerous arguments to adjust the update flow, making it flexible for a wide range of use cases.
22+
- **Support for Releases Without Assets**: In cases where no assets are found, the application can directly download the EXE or files from an external URL ([example](https://github.com/Zalexanninev15/GRU#example-visual-studio-code)).
23+
- **Multiple Downloader Options**: Choose between **curl**, **wget**, the built-in **gru** (**gru-classic**) or **tcpud** downloader for maximum flexibility in downloading assets.
24+
- **Seamless Archive Extraction**: Leverage **7-Zip** via the command line to handle nearly all types of archive files during the extraction process.
25+
- **Automatic Process Termination**: Automatically terminates the running application during updates to avoid issues with in-use applications, ensuring smooth updates.
26+
- **Pre-Update Script Support**: Optionally execute a custom `prepare.bat` file before the update to perform additional tasks.
27+
- **Post-Update Script Support**: Optionally execute a custom `script.bat` file after the update to perform additional tasks.
28+
- **Comprehensive and Self-Sufficient Documentation**: View detailed documentation by running `gru.exe` without any arguments to understand every option and its usage.
29+
- **Version Control for Precise Updates**: Fine-tune the update process by determining the current version and ensuring that the right release is applied based on your setup.
30+
- **Automatic Cleanup**: Automatically remove temporary files post-update to keep your system clean. Most cases work without issues, but a few may require manual intervention.
31+
- **Pre-release Support**: Optionally select pre-releases for updates if a stable release is not available or if the latest unstable release is preferred.
32+
- **Asset Search Across Multiple Releases**: Search for assets across multiple recent releases (not just the latest), ensuring you always get the right version of the file.
33+
34+
## Available arguments
35+
- `--app <application.exe>` — Set the EXE of the launcher/main application.
36+
- `--main <path>` — Set the path to the main application located one level above the EXE.
37+
- `--extract` / `--no-extract` — Decide whether to extract archive files or simply move the downloaded EXE.
38+
- `--leave` / `--no-leave` — Control whether to keep or remove unnecessary folders.
39+
- `--before` / `--no-before` — Run a `prepare.bat` script before downloading (optional).
40+
- `--script` / `--no-script` — Optionally run `script.bat` after the download and extraction.
41+
- `--silent` / `--no-silent` — Hide the console window during execution for a quieter experience.
42+
- `--details` / `--no-details` — Show detailed download information using curl/wget.
43+
- `--tool <type>` — Choose between download tools like `curl`, `wget`, `gru`, `gru-classic`, or `tcpud`.
44+
- `--link <url>` — Use a direct download link when assets are unavailable in the release.
45+
- `--ua <user-agent>` — Customize the user-agent string for optimized download speeds.
46+
- `--gh <personal access token>` — Use a GitHub personal access token for improved access if there are restrictions.
47+
- `--wgetrc` / `--no-wgetrc` — Use the wget configuration file (.wgetrc).
48+
- `--pre` / `--no-pre` — Use pre-releases if stable versions are unavailable.
49+
- `--ghost` / `--no-ghost` — Search for assets across multiple recent releases, not just the latest.
50+
51+
This program offers total control over your application updates and downloads, ensuring a smooth, customizable, and clean update process every time.
52+
53+
> A simplified description is provided here, and a more detailed one is provided in the utility itself.
3054
3155
## System requirements
3256

0 commit comments

Comments
 (0)