Skip to content

Commit f96ed84

Browse files
committed
add local dev info to readme
1 parent d18fc02 commit f96ed84

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

readme.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,14 @@ The following configuration options are available:
8080
| `lib.emailservice.scheduling.enabled` | true | Enables the scheduler sending the emails. |
8181
| `lib.emailservice.scheduling.interval` | 30000 | Specifies the milliseconds delay between runs of the scheduler. |
8282

83+
## Local development:
84+
85+
To use this library as a local development dependency, you can simply refer to the version `BUILD-SNAPSHOT`.
86+
87+
Check out this repository and run the maven goal `install`. This will build and install this library as version `BUILD-SNAPSHOT` into your local maven cache.
88+
89+
Note that you may have to tell your IDE to reload your main maven project each time you build the library.
90+
8391
## Building and releasing a new version:
8492

8593
To create a new version of this package and push it to the maven registry, you will have to use the GitHub actions workflow and manually trigger it.

0 commit comments

Comments
 (0)