Skip to content
This repository has been archived by the owner on Jun 26, 2022. It is now read-only.

Commit

Permalink
Update README.md with usage and build instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ChargedByte committed Dec 13, 2021
1 parent eba3c59 commit 6b6f326
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 @@ -2,5 +2,32 @@

SimpleJarWrapper allows you to run another jar file as a subprocess.

## Usage

Download a release jar file from the [releases](https://github.com/ChargedByte/SimpleJarWrapper/releases) page or build
it yourself.

Place the jar file along with the configuration file in to a directory. You can see the example configuration
file ***[here](wrapper.example.yaml)*** for the available options.

Then you can just run the jar file with the following command:

```shell
$ java -jar SimpleJarWrapper-<VERSION>-all.jar
```

## Build

Project is intended to be compiled with JDK 11 or later.

Clone the repository to your desired location and run the following command to build the jar file:

```shell
$ ./gradlew build
```

This should produce a `SimpleJarWrapper-<VERSION>-all.jar` file in the `build/libs` directory.

## License

This project is licensed under the [MIT license](LICENSE).

0 comments on commit 6b6f326

Please sign in to comment.