Skip to content

Commit

Permalink
release: v0.1.0
Browse files Browse the repository at this point in the history
- Update `CHANGELOG.md` for initial release notes
- Adjust `README.md` with usage instructions for 0.1.0 release

Signed-off-by: Art Shendrik <artyom.shendrik@gmail.com>
  • Loading branch information
amal committed Nov 26, 2024
1 parent 4825a3e commit 0b85a9b
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 9 deletions.
21 changes: 17 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,20 @@
# Changelog
# Changelog [^1]

## Pending changes

- Initial release
## Unreleased

[//]: # (Removed, Added, Changed, Fixed, Updated)


## [0.1.0] - 2024-11-26

🌱 _Initial Maven Central release._


## Notes

[0.1.0]: https://github.com/fluxo-kt/fluxo-io/releases/tag/v0.1.0

[^1]: Uses [Common Changelog style](https://common-changelog.org/) [^2]
[^2]: https://github.com/vweevers/common-changelog#readme

<div style="text-align: center"><small>..date..</small></div>
21 changes: 17 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

![Stability: Alpha](https://kotl.in/badges/alpha.svg)
[![Version][badge-mvn]][mvn]
[![Snapshot Version][badge-snapshot]][snapshot]
[![Kotlin Version][badge-kotlin]][badge-kotlin-link]
[![Build](../../actions/workflows/build.yml/badge.svg)](../../actions/workflows/build.yml)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue)](LICENSE)
Expand All @@ -21,8 +20,22 @@
> **Benchmarks and complete test coverage are coming.**

You can use snapshots from JitPack repository.<br>
[![JitPack][badge-jitpack]][jitpack]
### How to use

[![Version][badge-mvn]][mvn]

```kotlin
// in the `build.gradle.kts` of the target module.
plugins {
kotlin("multiplatform") version "2.0.21"
}
dependencies {
implementation("io.github.fluxo-kt:fluxo-io:0.1.0") // <-- add here
}
```

You can also use snapshots from Maven Central or JitPack:<br>
[![Snapshot Version][badge-snapshot]][snapshot] [![JitPack][badge-jitpack]][jitpack]


Library provides cross-platform [`RandomAccessData`][RandomAccessData]
Expand Down Expand Up @@ -115,7 +128,7 @@ This project is licensed under the Apache License, Version 2.0 — see the
[badge-wasi]: http://img.shields.io/badge/-WASM.WASI-F72585?logo=webassembly&logoColor=FCFDFD

[mvn]: https://mvnrepository.com/artifact/io.github.fluxo-kt/fluxo-io
[badge-mvn]: https://img.shields.io/maven-central/v/io.github.fluxo-kt/fluxo-io?logo=apachemaven
[badge-mvn]: https://img.shields.io/maven-central/v/io.github.fluxo-kt/fluxo-io?logo=apachemaven&labelColor=c71a36&color=666

[snapshot]: https://s01.oss.sonatype.org/content/repositories/snapshots/io/github/fluxo-kt/fluxo-io
[badge-snapshot]: https://img.shields.io/badge/dynamic/xml?color=666&logo=apachemaven&labelColor=c71a36&label=&query=%2F%2Fversion%5Blast%28%29%5D&url=https%3A%2F%2Fs01.oss.sonatype.org%2Fcontent%2Frepositories%2Fsnapshots%2Fio%2Fgithub%2Ffluxo-kt%2Ffluxo-io%2Fmaven-metadata.xml
Expand Down
3 changes: 2 additions & 1 deletion gradle/libs.versions.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

[versions]

version = "0.1.0-SNAPSHOT"
# WARNING: Remember to update the version in `README.md` examples!
version = "0.1.0"

# AutoCloseable requires API level 19 (Android 4.4)
androidMinSdk = "19"
Expand Down

0 comments on commit 0b85a9b

Please sign in to comment.