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 090e4a6 commit 714573c
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-permissions](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-permissions/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-permissions/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.61-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-permissions/images/download.svg) ](https://bintray.com/icerockdev/moko/moko-permissions/_latestVersion) ![kotlin-version](https://img.shields.io/badge/kotlin-1.3.70-orange)

# Mobile Kotlin runtime permissions multiplatform controller
**moko-permissions** - Kotlin MultiPlatform library for providing runtime permissions on iOS & Android.
Expand All @@ -22,7 +22,7 @@
- **DeniedException** and **DeniedAlwaysException** - exceptions to handle user denial of permissions

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

Expand All @@ -33,6 +33,8 @@
- kotlin 1.3.61
- 0.3.0
- 0.4.0
- kotlin 1.3.70
- 0.5.0

## Installation
root **build.gradle**
Expand All @@ -47,15 +49,10 @@ allprojects {
project **build.gradle**
```groovy
dependencies {
commonMainApi("dev.icerock.moko:permissions:0.4.0")
commonMainApi("dev.icerock.moko:permissions:0.5.0")
}
```

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

## List of supported permissions

The full list can be found in `dev.icerock.moko.permissions.Permission` enum.
Expand Down Expand Up @@ -114,7 +111,7 @@ More examples can be found in the [sample directory](sample).
## Set Up Locally
- In [permissions directory](permissions) contains `permissions` library;
- In [sample directory](sample) contains samples on android, ios & mpp-library connected to apps;
- For test changes locally use `:permissions:publishToMavenLocal` gradle task, after it samples will use locally published version.
- For test changes locally use `./publishToMavenLocal.sh` script, after it samples will use locally published version.

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

0 comments on commit 714573c

Please sign in to comment.