Adding section of changes in README.md

This commit is contained in:
david 2024-05-18 18:07:38 +02:00
parent 916b229645
commit 25db9414f9

View File

@ -17,6 +17,7 @@ Warp is written in Rust and is supported on Linux, Windows and macOS.
+ [Performance](#performance)
+ [Packages cache location](#packages-cache-location)
+ [Runners cache location](#runners-cache-location)
* [Changes in v1.0.0](#changes-in-v1.0.0)
* [Authors](#authors)
* [License](#license)
@ -550,8 +551,41 @@ The performance characteristics of the generated self-contained application is r
- macOS: `$HOME/Library/Application Support/warp/runners`
- Windows: `%LOCALAPPDATA%\warp\runners`
## Changes in v1.0.0
Version 1.0.0 introduces several breaking changes and new features, implemented via a cherry-pick from the [forked project](https://github.com/Reisz/warp). You can see the detailed differences in the [comparison](https://github.com/dgiagio/warp/compare/master...Reisz:warp:master).
### Breaking Changes
Until version 0.3.0, the default invocation of the program was:
```sh
warp-packer <argument1> <argument2> ...
```
From version 1.0.0 onwards, the default invocation has changed to:
```sh
warp-packer pack <argument1> <argument2> ...
```
### New Options in 1.0.0
Version 1.0.0 introduces the following new options:
```sh
-i, --input-dir <INPUT_DIR> Sets the input directory containing the application and dependencies
-q, --unique-id Generate a unique ID for each package build
-p, --prefix <PREFIX> Use a prefix instead of the single-file executable name
-n, --no-clean When using unique-id, do not clean obsolete versions with the same prefix from the cache
```
### Detailed Explanation of New Options
- **`-i, --input-dir <INPUT_DIR>`**: In previous versions, this option was specified as `--input_dir`. It sets the directory containing the application and its dependencies.
- **`-q, --unique-id`**: Instead of using a static folder name for the extracted application, a UUID will be used as the folder name. This is useful for shipping or testing different versions of your application without overwriting the old one. For example, `<cache_location>/warp/packages/<jar_name>/<unique_uuid>`.
- **`-p, --prefix <PREFIX>`**: This option allows you to use a specified prefix as the folder name in the cache location where the application will be extracted. For example, `<cache_location>/warp/packages/<PREFIX>/`.
- **`-n, --no-clean`**: By default, the folder with the autogenerated UUID and its content will be replaced with the new extracted files. If this option is set, the executable application will not delete the old extracted files in the cache location.
## Authors
- Diego Giagio `<diego@giagio.com>`
- Diego Giagio `<diego@giagio.com>` (
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details