aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2017-06-29 16:23:37 -0700
committerAllan Wang <me@allanwang.ca>2017-06-29 16:23:37 -0700
commitd00d7203c391c7954a4cd16a5f1d1f81ba873eb1 (patch)
tree70eaa4f66d09acf38e46997aee55c81995b7a9e1 /README.md
parentbfb16f2d56dd4da8d302a924efb7ea119582fde0 (diff)
downloadkau-d00d7203c391c7954a4cd16a5f1d1f81ba873eb1.tar.gz
kau-d00d7203c391c7954a4cd16a5f1d1f81ba873eb1.tar.bz2
kau-d00d7203c391c7954a4cd16a5f1d1f81ba873eb1.zip
Update readme and changelog
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/README.md b/README.md
index 1968f45..145515d 100644
--- a/README.md
+++ b/README.md
@@ -42,6 +42,7 @@ dependencies {
* [Changelog XML](#changelog)
* [Search View](#search-view)
* [Ripple Canvas](#ripple-canvas)
+* [About Activity](#about-activity)
* [Timber Logger](#timber-logger)
* [Extensions](#extensions)
* [Email Builder](#email-builder)
@@ -204,6 +205,24 @@ They can be used as transitions, or as a toolbar background to replicate the loo
Many ripples can be stacked on top of each other to run at the same time from different locations.
The canvas also supports color fading and direct color setting so it can effectively replace any background.
+<a name="about-activity"></a>
+## About Activity
+
+Most apps could not be possible without the collective efforts of other developers and their libraries.
+It's always nice to give credit where credit is due, but it's not always at the top of ones agenda.
+About Activity aims to fix that by preparing a beautiful overlay activity that does just that.
+
+<img src="https://github.com/AllanWang/Storage-Hub/blob/master/kau/kau_about_activity.gif">
+
+The overlay is heavily based off of the about section in [Plaid](https://github.com/nickbutcher/plaid),
+and adds on the power of [About Libraries](https://github.com/mikepenz/AboutLibraries) to automatically find the dependencies
+
+This activity can be easily added by extending `AboutActivityBase`.
+Everything is already prepared, but you can modify the theme or other components through the config DSL or through the open functions.
+There are also numerous iitem cards already prepared if you wish to add that in your main view.
+
+Be sure to include the activity in your Manifest and have it extend `Kau.Translucent.About`, or any other style that achieves the same look.
+
<a name="timber-logger"></a>
## Timber Logger