Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex009 committed May 5, 2020
1 parent 2e4a0e3 commit d545073
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![moko-resources](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-resources/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-resources/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.71-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-resources/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-resources/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.72-orange)

# Mobile Kotlin resources
This is a Kotlin MultiPlatform library that provides access to the resources on iOS & Android with the support of the default system localization.
Expand All @@ -16,7 +16,7 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
- [License](#license)

## Features
- **Strings, Plurals, Images** to access the corresponding resources from common code;
- **Strings, Plurals, Images, Fonts, Files** to access the corresponding resources from common code;
- **StringDesc** for lifecycle-aware access to resources and unified localization on both platforms.

## Requirements
Expand All @@ -42,6 +42,8 @@ This is a Kotlin MultiPlatform library that provides access to the resources on
- 0.9.0
- kotlin 1.3.71
- 0.9.1
- kotlin 1.3.72
- 0.10.0

## Installation
root build.gradle
Expand All @@ -52,7 +54,7 @@ buildscript {
}
dependencies {
classpath "dev.icerock.moko:resources-generator:0.9.1"
classpath "dev.icerock.moko:resources-generator:0.10.0"
}
}
Expand All @@ -69,7 +71,7 @@ project build.gradle
apply plugin: "dev.icerock.mobile.multiplatform-resources"
dependencies {
commonMainApi("dev.icerock.moko:resources:0.9.1")
commonMainApi("dev.icerock.moko:resources:0.10.0")
}
multiplatformResources {
Expand Down Expand Up @@ -288,8 +290,7 @@ Please see more examples in the [sample directory](sample).
- The [resources directory](resources) contains the `resources` library;
- The [gradle-plugin directory](gradle-plugin) contains a gradle plugin with a `MR` class generator;
- The [sample directory](sample) contains sample apps for Android and iOS; plus the mpp-library connected to the apps;
- For local testing a library use the `:resources:publishToMavenLocal` gradle task - so that sample apps use the locally published version.
- For local testing a plugin use the `:gradle-plugin:publishToMavenLocal` gradle task so that sample apps will 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 d545073

Please sign in to comment.