diff options
| -rw-r--r-- | README.md | 18 | ||||
| -rw-r--r-- | core/README.md | 9 |
2 files changed, 18 insertions, 9 deletions
@@ -4,7 +4,7 @@ Kotlin Android Utils This library contains small helper functions used throughout almost all of my other projects. The goal is to make common interactions executable in a single line. -[Changelog](https://github.com/AllanWang/KAU/tree/master/docs/Changelog.md) +[Changelog](docs/Changelog.md) ------------ @@ -50,7 +50,7 @@ dependencies { # Submodules (linked to their respective Docs) -## [Core](/core#readme) +## [Core](core#readme) * Collection of extension functions and small helper methods applicable in almost any application. * Notable features: KPrefs, Changelog XML, Ripple Canvas, Extensions, Email Builder * Includes @@ -61,7 +61,7 @@ dependencies { [`Timber`](https://github.com/JakeWharton/timber), [`Kotlin stdlib`](https://kotlinlang.org/api/latest/jvm/stdlib/) -## [Core UI](/core-ui#readme) +## [Core UI](core-ui#readme) * Collection of complex views and widgets * Includes `:core`, `:adapter`, [`RxJava`](https://github.com/ReactiveX/RxJava), @@ -69,31 +69,31 @@ dependencies { [`RxKotlin`](https://github.com/ReactiveX/RxKotlin), [`RxBinding`](https://github.com/JakeWharton/RxBinding) -## [About](/about#readme) +## [About](about#readme) * Implementation of an overlaying about section, along with automatic lib detection; also includes the lib strings for KAU * Includes `:core-ui`, `:adapter`, [`About Libraries`](https://github.com/mikepenz/AboutLibraries) -## [Adapter](/adapter#readme) +## [Adapter](adapter#readme) * Kotlin bindings for the fast adapter, as well as RecyclerView animations * Includes `:core`, [`Fast Adapter`](https://github.com/mikepenz/FastAdapter) -## [Color Picker](/colorpicker#readme) +## [Color Picker](colorpicker#readme) * Implementation of a color picker dialog with subtle transitions and a decoupled callback * Includes `:core`, [`Material Dialogs (commons)`](https://github.com/afollestad/material-dialogs) -## [Image Picker](/imagepicker#readme) +## [Image Picker](imagepicker#readme) * WIP - Overlaying media chooser * Includes `:core-ui`, [`Glide`](https://github.com/bumptech/glide) -## [Kpref Activity](/kpref-activity#readme) +## [Kpref Activity](kpref-activity#readme) * Fully programmatic implementation of a Preference Activity, backed by RecyclerViews * Includes `:core-ui`, `:adapter`, `colorpicker` -## [SearchView](/searchview#readme) +## [SearchView](searchview#readme) * Material searchview with kotlin bindings * Includes `:core-ui`, `:adapter` diff --git a/core/README.md b/core/README.md index 8619cf5..c8934e4 100644 --- a/core/README.md +++ b/core/README.md @@ -117,25 +117,31 @@ Include your email and subject, along with other optional configurations such as Note that since KAU depends on [ANKO](https://github.com/Kotlin/anko), all of the extensions in its core package is also in KAU. ### AnimUtils + > Extends View * Fade In/Fade Out/Circle Reveal with callbacks * Switch texts in a TextView with a fade transition ### ColorUtils + > Extends Int * Check if color is dark or light * Check if color is visible against another color * Convert color to HSV (float[]) or hex (String) * Get the disabled color of a theme * Adjust alpha + > Extends String * Parses color; adds onto the original parser by supporting #AAA values + > Extends View * Various tinting for different views; taken from [MDTintHelper](https://github.com/afollestad/material-dialogs/blob/master/core/src/main/java/com/afollestad/materialdialogs/internal/MDTintHelper.java) ### ContextUtils + > Extends Activity * Restart an activity + > Extends Context * Start Activity using the class, with optional intents and stack clearing * Create a toast directly @@ -145,16 +151,19 @@ Note that since KAU depends on [ANKO](https://github.com/Kotlin/anko), all of th * Check if network is available ### IIconUtils + > Extends [IIcon](https://github.com/mikepenz/Android-Iconics) * `toDrawable` method that only requires a context; defaults to a white icon of size 24dp and uses a ColorStateList to allow for dimming ### Utils [Misc] + > Extends Int * dpToPx & pxToDp conversions * Check sdk version * Check if app is installed ### ViewUtils + > Extends View * `visible()`, `invisible()`, `gone()`, `isVisible()`, `isInvisible()`, `isGone()` methods * matchParent method to set the layout params to match_parent |