Skip to content

Commit

Permalink
docs: update readme and roadmap
Browse files Browse the repository at this point in the history
Signed-off-by: Art Shendrik <[email protected]>
  • Loading branch information
amal committed Jun 29, 2024
1 parent 19985c5 commit d5110e1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,21 +58,36 @@ Different platform-specific implementations are provided.
[() -> ReadableByteChannel]: fluxo-io-rad/src/commonJvmMain/kotlin/fluxo/io/rad/StreamFactoryRadAccessor.kt#L122
[AsynchronousFileChannel]: fluxo-io-rad/src/commonJvmMain/kotlin/fluxo/io/rad/AsyncFileChannelRadAccessor.kt#L32

<details>
<summary>History notes</summary>

_The first steps of the implementation were dated 2021-03-31 (2d87ec044f5801cd3ad8cc31ac380b17fa31d44a)._<br>
_Open-source since 2024-06-16._
</details>


### Related or alternative projects

* [Okio](https://github.com/square/okio)
* [Kotlinx IO](https://github.com/Kotlin/kotlinx-io)
* [Ktor IO](https://github.com/ktorio/ktor/tree/main/ktor-io)
* [DitchOoM Buffer](https://github.com/DitchOoM/buffer)


### Versioning

Uses [SemVer](http://semver.org/) for versioning. <br>
For the versions available, see the [tags on this repository](../../tags).


### License

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)

This project is licensed under the Apache License, Version 2.0 — see the
[license](LICENSE) file for details.


[badge-kotlin]: http://img.shields.io/badge/Kotlin-2.0.0-7F52FF?logo=kotlin&logoWidth=10&logoColor=7F52FF&labelColor=2B2B2B
[badge-kotlin-link]: https://github.com/JetBrains/kotlin/releases

Expand Down
11 changes: 7 additions & 4 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,11 @@
<details>
<summary>Show</summary>

* https://github.com/square/okio
* https://github.com/Kotlin/kotlinx-io
* https://github.com/ktorio/ktor/tree/main/ktor-io
* https://github.com/DitchOoM/buffer
* Port tests.
* Set up code coverage.
* Port benchmarks.
* Set up multiplatform benchmarks.
* Kotlin/Native implementations.
* Node.JS implementations.
* Wasm.Wasi implementations.
</details>

0 comments on commit d5110e1

Please sign in to comment.