Skip to content

Commit

Permalink
chore(publish): prepare for 0.0.1
Browse files Browse the repository at this point in the history
  • Loading branch information
hoc081098 committed Dec 3, 2023
1 parent 8713ed6 commit 6c7df60
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 6 deletions.
62 changes: 57 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,63 @@ Liked some of my work? Buy me a coffee (or more likely a beer)

<a href="https://www.buymeacoffee.com/hoc081098" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-blue.png" alt="Buy Me A Coffee" height=64></a>

## Docs

- `0.x release` docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/0.x
- Snapshot docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/latest/

## Installation

```kotlin
allprojects {
repositories {
[...]
mavenCentral()
}
}
```

```kotlin
implementation("io.github.hoc081098:channel-event-bus:0.0.1")
```

### Snapshot

<details>
<summary>Snapshots of the development version are available in Sonatype's snapshots repository.</summary>

- Kotlin

```kotlin
allprojects {
repositories {
[...]
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
}
}

dependencies {
implementation("io.github.hoc081098:channel-event-bus:0.0.2-SNAPSHOT")
}
```

- Groovy

```groovy
allprojects {
repositories {
[...]
maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
}
}
dependencies {
implementation 'io.github.hoc081098:channel-event-bus:0.0.2-SNAPSHOT'
}
```

</details>

## Basic usage

```kotlin
Expand Down Expand Up @@ -78,11 +135,6 @@ bus
- `tvosX64`, `tvosSimulatorArm64`, `tvosArm64`.
- `macosX64`, `macosArm64`.

## Docs

- `0.x release` docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/0.x
- Snapshot docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/latest/

## Sample

- [Android Compose sample](https://github.com/hoc081098/kotlin-channel-event-bus/tree/master/sample/app):
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ kotlin.incremental=true
# POM
GROUP=io.github.hoc081098
# HEY! If you change the major version here be sure to update publish-release.yaml doc target folder!
VERSION_NAME=0.0.1-SNAPSHOT
VERSION_NAME=0.0.1
POM_INCEPTION_YEAR=2023

POM_URL=https://github.com/hoc081098/kotlin-channel-event-bus
Expand Down

0 comments on commit 6c7df60

Please sign in to comment.