Skip to content

Commit

Permalink
Update readme files
Browse files Browse the repository at this point in the history
  • Loading branch information
vpriscan committed Jun 28, 2019
1 parent 92df626 commit acff6f4
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Use RxKotlin 1.x versions to target RxJava 1.x.

Use RxKotlin 2.x versions to target RxJava 2.x.

The maintainers do not update the RxJava dependency version for every RxJava release, so you should explicitly add the desired RxJava dependency version to your `pom.xml` or `build.gradle`.
The maintainers do not update the RxJava dependency version for every RxJava release, so you should explicitly add the desired RxJava dependency version to your `pom.xml` or `build.gradle(.kts)`.

## Build

Expand All @@ -78,8 +78,8 @@ Example for Maven:

and for Gradle:

```groovy
implementation 'io.reactivex.rxjava2:rxkotlin:x.y.z'
```kotlin
implementation("io.reactivex.rxjava2:rxkotlin:x.y.z")
```

### RxKotlin 1.x
Expand All @@ -96,8 +96,8 @@ Example for Maven:

and for Gradle:

```groovy
implementation 'io.reactivex:rxkotlin:x.y.z'
```kotlin
implementation("io.reactivex:rxkotlin:x.y.z")
```

### Building with JitPack
Expand Down
6 changes: 3 additions & 3 deletions RELEASING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Release Process
===============

1. Ensure `VERSION_NAME` in `gradle.properties` is set to the version you want to release.
1. Ensure `version` in `gradle.properties` is set to the version you want to release.
2. Add an entry in `CHANGELOG.md` with the changes for the release.
3. Update `README.md` with the version about to be released. Also update the RxJava version in
this file to its latest.
4. Update the RxJava version in `rxkotlin/build.gradle` to its latest. (We tell people that we
4. Update the RxJava version in `rxkotlin/build.gradle.kts` to its latest. (We tell people that we
won't be tracking RxJava releases, and we don't, but we do it anyway when we are releasing for
those who ignore the advice.)
5. Commit: `git commit -am "Prepare version X.Y.X"`
Expand All @@ -14,6 +14,6 @@ Release Process
you just tagged version 1.0.4 you would set this value to 1.0.5. Do NOT append "-SNAPSHOT" to
this value, it will be added automatically.
8. Commit: `git commit -am "Prepare next development version."`
9. Push: `git push && git push --tags`
9. Push: `git push --follow-tags`
10. Paste the `CHANGELOG.md` contents for this version into a Release on GitHub along with the
Groovy for depending on the new version (https://github.com/ReactiveX/RxKotlin/releases).

0 comments on commit acff6f4

Please sign in to comment.