danielvici123/dhl
1
1
Fork 0
Code Issues 5 Pull Requests Actions Packages Projects Releases 4 Wiki Activity

docs: update README and add example configuration files

Browse Source
This commit is contained in:
danielvici123
2026-06-08 21:27:16 +02:00
parent 922b7170a4
commit d778a5d37e
3 changed files with 46 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -96,9 +96,21 @@ cargo run
cargo build --release
```
### Release Assets
When downloading a release, you will find:
- The `dhl` binary (Linux) or `dhl.exe` (Windows).
- `config.json`: An example configuration file.
- `response.json`: An example response file.
Simply place the binary and the two JSON files in the same folder and start the application.
### CI/CD
This project includes a Gitea Actions workflow that automatically builds the binary when a version tag (e.g., `v1.0.0`) is pushed to the repository.
This project includes a Gitea Actions workflow that automatically:
1. Builds the application for **Linux** and **Windows**.
2. Packages them into `dhl-linux.tar.gz` and `dhl-windows.zip` respectively, including example configuration files.
3. Creates a Gitea Release with these assets whenever a version tag (e.g., `v0.5.0`) is pushed.
## Project Structure