Added Config builder

This commit is contained in:
Erik C. Thauvin 2024-05-11 15:52:31 -07:00
parent 281f43fe1d
commit 962aa6a86c
Signed by: erik
GPG key ID: 776702A6A2DA330E
8 changed files with 174 additions and 10 deletions

View file

@ -40,9 +40,11 @@ repositories = List.of(MAVEN_CENTRAL);
scope(compile)
.include(dependency("net.thauvin.erik:readingtime:0.9.2"));
```
Be sure to use the [bld Kotlin extension](https://github.com/rife2/bld-kotlin) in your project.
### Gradle, Maven, etc.
To use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/readingtime/blob/master/examples/gradle/build.gradle.kts) file:
```gradle
@ -54,6 +56,7 @@ dependencies {
implementation("net.thauvin.erik:readingtime:0.9.2")
}
```
Instructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://search.maven.org/search?q=g:%22net.thauvin.erik%22%20AND%20a:%22readingtime%22).
## Properties
@ -108,6 +111,28 @@ A JSP tag is also available for easy incorporation into web applications:
None of the attributes are required.
## Java
In addition to setters, a configuration builder is also available:
```java
final ReadingTime rt = new ReadingTime(Files.readString(text));
rt.setPostfix("minute to read");
rt.setPlural("minutes to read");
```
or
```java
final Config config =
new Config.Builder()
.text(Files.readString(text))
.postfix("minute to read")
.plural("minutes to read")
.build();
final ReadingTime rt = new ReadingTime(config);
```
## Contributing
If you want to contribute to this project, all you have to do is clone the GitHub