Skip to content

Commit bddf816

Browse files
committed
Update README
1 parent 084b651 commit bddf816

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,33 @@
11
# Tasks
22

3+
[![build](https://github.com/funfix/tasks/actions/workflows/build.yaml/badge.svg)](https://github.com/funfix/tasks/actions/workflows/build.yaml) [![maven](https://img.shields.io/maven-central/v/org.funfix/tasks-jvm.svg)](https://central.sonatype.com/artifact/org.funfix/tasks-jvm) [![javadoc](https://javadoc.io/badge2/org.funfix/tasks-jvm/javadoc.svg)](https://javadoc.io/doc/org.funfix/tasks-jvm)
4+
5+
This is a library meant for library authors that want to build libraries that work across Java, Scala, or Kotlin, without having to worry about interoperability with whatever method of I/O that the library is using under the hood.
6+
37
## Usage
48

9+
Read the [Javadoc](https://javadoc.io/doc/org.funfix/tasks-jvm).
10+
Better documentation is coming.
11+
12+
---
13+
14+
Maven:
515
```xml
616
<dependency>
717
<groupId>org.funfix</groupId>
818
<artifactId>tasks-core-jvm</artifactId>
9-
<version>0.0.1</version>
19+
<version>0.0.3</version>
1020
</dependency>
1121
```
1222

13-
## Development
14-
15-
### Important Files
23+
Gradle:
24+
```kotlin
25+
dependencies {
26+
implementation("org.funfix:tasks-core-jvm:0.0.3")
27+
}
28+
```
1629

17-
- [gradle.properties](./gradle.properties) configures the project's version.
18-
- [gradle/libs.versions.toml](./gradle/libs.versions.toml) configures the versions of the dependencies.
30+
sbt:
31+
```scala
32+
libraryDependencies += "org.funfix" % "tasks-core-jvm" % "0.0.3"
33+
```

0 commit comments

Comments
 (0)