Skip to content

Commit b8ec033

Browse files
committed
Mention filesystems and paths in README
1 parent e421c04 commit b8ec033

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,16 @@ The library also provides interfaces representing data sources and destinations
2121

2222
In addition to `Buffer`, the library provides an immutable sequence of bytes - `ByteString`.
2323

24+
Also, there's an experimental filesystem support provided by `kotlinx.io.files` package.
25+
The package includes `FileSystem` interface and its implementation - `SystemFileSystem`.
26+
27+
`FileSystem` provides basic operations for working with files and directories.
28+
29+
File and directory paths are represented by yet another class provided by the package - `Path`.
30+
2431
There are two `kotlinx-io` modules:
2532
- [kotlinx-io-bytestring](./bytestring) - provides `ByteString`.
26-
- [kotlinx-io-core](./core) - provides IO primitives (`Buffer`, `Source`, `Sink`), depends on `kotlinx-io-bytestring`.
33+
- [kotlinx-io-core](./core) - provides IO primitives (`Buffer`, `Source`, `Sink`), filesystems support, depends on `kotlinx-io-bytestring`.
2734

2835
## Using in your projects
2936

0 commit comments

Comments
 (0)