Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex009 committed Mar 14, 2020
1 parent 107ae09 commit 8df3646
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![moko-parcelize](img/logo.png)
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://api.bintray.com/packages/icerockdev/moko/moko-parcelize/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-parcelize/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.60-orange)
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0) [![Download](https://api.bintray.com/packages/icerockdev/moko/moko-parcelize/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-parcelize/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.70-orange)

# Mobile Kotlin parcelize
This is a Kotlin Multiplatform library that supports Parcelize in common code.
Expand All @@ -19,7 +19,7 @@ This is a Kotlin Multiplatform library that supports Parcelize in common code.
- **Parcelize** in common code (specially for Android target).

## Requirements
- Gradle version 5.4.1+
- Gradle version 5.6.4+
- Android API 16+
- iOS version 9.0+

Expand All @@ -28,6 +28,8 @@ This is a Kotlin Multiplatform library that supports Parcelize in common code.
- 0.1.0
- kotlin 1.3.60
- 0.2.0
- kotlin 1.3.70
- 0.3.0

## Installation
root build.gradle
Expand All @@ -42,7 +44,7 @@ allprojects {
project build.gradle
```groovy
dependencies {
commonMainApi("dev.icerock.moko:parcelize:0.2.0")
commonMainApi("dev.icerock.moko:parcelize:0.3.0")
}
```

Expand All @@ -51,11 +53,6 @@ Enable [kotlin android extensions](https://kotlinlang.org/docs/tutorials/android
apply plugin: 'kotlin-android-extensions'
```

settings.gradle
```groovy
enableFeaturePreview("GRADLE_METADATA")
```

## Usage
### Parcelize
Mark common code classes with the annotation `@Parcelize` like in the Android code for automatically generated `Parcelable` implementation.
Expand All @@ -73,7 +70,7 @@ Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [parcelize directory](parcelize) contains the `parcelize` library;
- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps;
- For local testing use the `:parcelize:publishToMavenLocal` gradle task - so that sample apps use the locally published version.
- For local testing use the `./publishToMavenLocal.sh` script - so that sample apps use the locally published version.

## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This way `master` always contains the sources of the most recently released version. Please send PRs with bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to this rule. They are updated directly in `master`.
Expand Down

0 comments on commit 8df3646

Please sign in to comment.