Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
fzhinkin committed Nov 27, 2024
1 parent 1e1544e commit b335f42
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ which includes the `FileSystem` interface and its default implementation - `Syst

There are two `kotlinx-io` modules:
- [kotlinx-io-bytestring](./bytestring) - provides `ByteString`.
- [kotlinx-io-core](./core) - provides IO primitives (`Buffer`, `Source`, `Sink`), filesystems support, depends on `kotlinx-io-bytestring`.
- [kotlinx-io-core](./core) - provides IO primitives (`Buffer`, `Source`, `Sink`), depends on `kotlinx-io-bytestring`.
- [kotlinx-io-filesystem](./filesystem) - provides basic filesystem support, depends on `kotlinx-io-core`.

## Using in your projects

Expand Down Expand Up @@ -81,6 +82,7 @@ Add the library to dependencies:
On JVM, `kotlinx-io` supports Java Modules:
- `kotlinx-io-bytestring` library provides `kotlinx.io.bytestring` module;
- `kotlinx-io-core` library provides `kotlinx.io.core` module.
- `kotlinx-io-filesystem` library provides `kotlinx.io.filesystem` module.

Read [this](https://kotlinlang.org/docs/gradle-configure-project.html#configure-with-java-modules-jpms-enabled) article
for details on how to configure a Gradle project to utilize JPMS.
Expand Down

0 comments on commit b335f42

Please sign in to comment.