Skip to content

Commit

Permalink
docs: Add usages
Browse files Browse the repository at this point in the history
  • Loading branch information
CarmJos committed Jan 19, 2024
1 parent 0456f09 commit 8320c79
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,33 @@ Advanced plugin and config updater, which can keep plugins up-to-dates and mixin

## Features & Advantages

## Usages & Examples

Download the latest version of the EasyUpdater from
the [releases](https://github.com/CarmJos/EasyUpdater/releases)
and put it in the folder of your application.

Then, create a new file named `updates.yml` or any other name you like.

```yaml
# Import other update configs, which will be loaded before this file.
# All configs will be run in order.
import:
- "<path-to-other-config>/general-updates.yml"

# Transfer files from the sources.
transfer:


# Mixin specific configuration files.
mixin:


```

Finally, run `java -jar EasyUpdater.jar [config-file-path]` to start the updater
before your own application boot up.

## Support and Donation

If you appreciate this plugin, consider supporting me with a donation!
Expand Down

0 comments on commit 8320c79

Please sign in to comment.