aboutsummaryrefslogtreecommitdiff
path: root/about
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2017-07-09 11:28:59 -0700
committerGitHub <noreply@github.com>2017-07-09 11:28:59 -0700
commite6ec9c5dd677be298430cb2b694f047c67b03239 (patch)
treef0bc2a630c9335b608ac9076ca868f5a5658c75c /about
parent0af8b379fc0968c830c8938e1998b5bd3dd7e0aa (diff)
downloadkau-e6ec9c5dd677be298430cb2b694f047c67b03239.tar.gz
kau-e6ec9c5dd677be298430cb2b694f047c67b03239.tar.bz2
kau-e6ec9c5dd677be298430cb2b694f047c67b03239.zip
KAU 2.0 (#1) - Update docs and finish up refractoring
* Update readme * Add docs for remaining submodules * Update searchview * Update links 1/3 * Update links 2/3 * Update links 3/3 * update changelog * Update readme * Test rename to readme * Rename remaining to readme * Link readme to repo
Diffstat (limited to 'about')
-rw-r--r--about/README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/about/README.md b/about/README.md
new file mode 100644
index 0000000..afbf89a
--- /dev/null
+++ b/about/README.md
@@ -0,0 +1,28 @@
+# KAU :about
+
+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.
+
+![About Activity Gif](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 (in this submodule and from `:adapter`)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.
+
+## Proguard
+
+Without auto detect, KAU about will retain the classes containing the lib strings by default.
+If you use proguard with auto detect, make sure to retain all R classes to make it possible
+
+```
+-keep class .R
+-keep class **.R$* {
+ <fields>;
+}
+``` \ No newline at end of file