Skip to content

Commit 9a11f59

Browse files
committed
Add user guide
1 parent a5d662e commit 9a11f59

2 files changed

Lines changed: 574 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,33 +24,50 @@ Supported database systems:
2424
- PostgreSQL
2525
- SQLite
2626

27+
Built on Java 21+, making good use of virtual threads. Has Scala (2.13, 3.x) integration.
28+
2729
### Documentation
2830

2931
- [Java Usage Guide](./docs/java-usage-guide.md)
30-
- [Javadoc](https://javadoc.io/doc/org.funfix/delayedqueue-jvm/0.5.1/org/funfix/tasks/jvm/package-summary.html)
32+
- [Scala Usage Guide](./docs/scala-usage-guide.md)
33+
- [Javadoc](https://javadoc.io/doc/org.funfix/delayedqueue-jvm/0.5.1/)
34+
- [Scaladoc](https://javadoc.io/doc/org.funfix/delayedqueue-scala_3/0.5.1/)
3135
- [Internals](./docs/internals.md)
3236

3337
---
3438

3539
Maven:
3640
```xml
41+
<!-- Java or Kotlin -->
3742
<dependency>
3843
<groupId>org.funfix</groupId>
3944
<artifactId>delayedqueue-jvm</artifactId>
4045
<version>0.5.1</version>
4146
</dependency>
47+
<!-- Scala 3 integration-->
48+
<dependency>
49+
<groupId>org.funfix</groupId>
50+
<artifactId>delayedqueue-scala_3</artifactId>
51+
<version>0.5.1</version>
52+
</dependency>
4253
```
4354

4455
Gradle:
4556
```kotlin
4657
dependencies {
58+
// Java or Kotlin
4759
implementation("org.funfix:delayedqueue-jvm:0.5.1")
60+
// Scala 3 integration
61+
implementation("org.funfix:delayedqueue-scala_3:0.5.1")
4862
}
4963
```
5064

5165
sbt:
5266
```scala
53-
libraryDependencies += "org.funfix" % "delayedqueue-jvm" % "0.5.1"
67+
// Base JVM library
68+
libraryDependencies += "org.funfix" %% "delayedqueue-jvm" % "0.5.1"
69+
// Scala integration (2.13 or 3)
70+
libraryDependencies += "org.funfix" %% "delayedqueue-scala" % "0.5.1"
5471
```
5572

5673
You will need to add a supported JDBC driver:

0 commit comments

Comments
 (0)