From c68d60f099e75773cf70ad6b1e012526cfa6d109 Mon Sep 17 00:00:00 2001 From: maltaisn Date: Sat, 30 May 2020 08:56:24 -0400 Subject: [PATCH] Updated readme --- README.md | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 674e8ea..d302f1e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Recurrence picker -Fully customizable recurrence picker dialog and fragment, compatible with API 19. +Fully customizable recurrence picker dialog and fragment, compatible with API 14. Easy to set up and to customize, almost every view can be styled with attributes. Several settings are available to change the picker interface and behavior. @@ -8,26 +8,27 @@ Several settings are available to change the picker interface and behavior. #### Gradle dependency `implementation 'com.maltaisn:recurpicker:X.Y.Z'` -Replace `X.Y.Z` with lastest version number: -[![Download](https://api.bintray.com/packages/maltaisn/recurrence-picker/recurrence-picker/images/download.svg)](https://bintray.com/maltaisn/recurrence-picker/recurrence-picker/_latestVersion) - -If you haven't migrated to AndroidX, use version 1.4.5. -Version 1.5.0 and above use AndroidX. - -Version 2.0.0 and above are written in Kotlin but should support Java well. -Note that v2 introduces major breaking changes, see the changelog for more info. +Replace `X.Y.Z` with lastest version number:  + + Download ## Documentation KDocs is available [here](https://maltaisn.github.io/recurpickerlib/lib/index.html). More documentation and examples is available on the [wiki](https://github.com/maltaisn/recurpickerlib/wiki) -- [Using the library](https://github.com/maltaisn/recurpickerlib/wiki/Using-the-library) +- [**Using the library**](https://github.com/maltaisn/recurpickerlib/wiki/Using-the-library) - [Building a recurrence](https://github.com/maltaisn/recurpickerlib/wiki/Building-a-recurrence) - [Formatting a recurrence](https://github.com/maltaisn/recurpickerlib/wiki/Formatting-a-recurrence) - [Recurrence serialization](https://github.com/maltaisn/recurpickerlib/wiki/Recurrence-serialization) - [Styling the fragments](https://github.com/maltaisn/recurpickerlib/wiki/Styling-the-fragments) ## Changelog -View [changelog](CHANGELOG.md). +Major changes are as follows: +- v1.5.0: AndroidX migration +- v2.0.0: Rewrite to Kotlin, major breaking changes. +- v2.1.0: Backported to API 14. + +See [changelog](CHANGELOG.md) for detailed release notes. ## Credits - Thanks to [David Vavra](https://github.com/davidvavra) and his translators for translating to 10 languages.