Skip to content

Commit 6c7df60

Browse files
committed
chore(publish): prepare for 0.0.1
1 parent 8713ed6 commit 6c7df60

File tree

2 files changed

+58
-6
lines changed

2 files changed

+58
-6
lines changed

README.md

+57-5
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,63 @@ Liked some of my work? Buy me a coffee (or more likely a beer)
4444

4545
<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>
4646

47+
## Docs
48+
49+
- `0.x release` docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/0.x
50+
- Snapshot docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/latest/
51+
52+
## Installation
53+
54+
```kotlin
55+
allprojects {
56+
repositories {
57+
[...]
58+
mavenCentral()
59+
}
60+
}
61+
```
62+
63+
```kotlin
64+
implementation("io.github.hoc081098:channel-event-bus:0.0.1")
65+
```
66+
67+
### Snapshot
68+
69+
<details>
70+
<summary>Snapshots of the development version are available in Sonatype's snapshots repository.</summary>
71+
72+
- Kotlin
73+
74+
```kotlin
75+
allprojects {
76+
repositories {
77+
[...]
78+
maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/")
79+
}
80+
}
81+
82+
dependencies {
83+
implementation("io.github.hoc081098:channel-event-bus:0.0.2-SNAPSHOT")
84+
}
85+
```
86+
87+
- Groovy
88+
89+
```groovy
90+
allprojects {
91+
repositories {
92+
[...]
93+
maven { url "https://s01.oss.sonatype.org/content/repositories/snapshots/" }
94+
}
95+
}
96+
97+
dependencies {
98+
implementation 'io.github.hoc081098:channel-event-bus:0.0.2-SNAPSHOT'
99+
}
100+
```
101+
102+
</details>
103+
47104
## Basic usage
48105

49106
```kotlin
@@ -78,11 +135,6 @@ bus
78135
- `tvosX64`, `tvosSimulatorArm64`, `tvosArm64`.
79136
- `macosX64`, `macosArm64`.
80137

81-
## Docs
82-
83-
- `0.x release` docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/0.x
84-
- Snapshot docs: https://hoc081098.github.io/kotlin-channel-event-bus/docs/latest/
85-
86138
## Sample
87139

88140
- [Android Compose sample](https://github.com/hoc081098/kotlin-channel-event-bus/tree/master/sample/app):

gradle.properties

+1-1
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ kotlin.incremental=true
2525
# POM
2626
GROUP=io.github.hoc081098
2727
# HEY! If you change the major version here be sure to update publish-release.yaml doc target folder!
28-
VERSION_NAME=0.0.1-SNAPSHOT
28+
VERSION_NAME=0.0.1
2929
POM_INCEPTION_YEAR=2023
3030

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

0 commit comments

Comments
 (0)