aboutsummaryrefslogtreecommitdiff
path: root/core/README.md
diff options
context:
space:
mode:
authorAllan Wang <me@allanwang.ca>2017-08-02 16:21:49 -0700
committerGitHub <noreply@github.com>2017-08-02 16:21:49 -0700
commit53382b44bb7ab7ccb559e96fd1f93c47020878ee (patch)
tree79c1862992f458ac52c1910b3a2e0c01cb7d5a5a /core/README.md
parent7d894be6de118357ec908d2d171b6152ce67307d (diff)
downloadkau-53382b44bb7ab7ccb559e96fd1f93c47020878ee.tar.gz
kau-53382b44bb7ab7ccb559e96fd1f93c47020878ee.tar.bz2
kau-53382b44bb7ab7ccb559e96fd1f93c47020878ee.zip
Improve video prefetching (#17)
* Create base activity and add thumbnails to media picker * Add checker to see if requested permission is inside the manifest * Add faq parser with tests * Add kpref testers and expose sp * Test jitpack sample exclusion * Test caching * Improve glide caching
Diffstat (limited to 'core/README.md')
-rw-r--r--core/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/core/README.md b/core/README.md
index c26836e..b952797 100644
--- a/core/README.md
+++ b/core/README.md
@@ -6,6 +6,7 @@
* [KPrefs](#kprefs)
* [Changelog XML](#changelog)
+* [FAQ XML](#faq-xml)
* [Kotterknife](#kotterknife)
* [Ripple Canvas](#ripple-canvas)
* [MeasureSpecDelegate](#measure-spec-delegate)
@@ -106,6 +107,20 @@ Here is a template xml changelog file:
</resources>
```
+<a name="faq-xml"></a>
+## FAQ XML
+
+There is another parser for a FAQ list with the following format:
+
+```xml
+<question>This is a question</question>
+<answer>This is an answer</answer>
+```
+
+Calling `kauParseFaq` will give you a `List<Pair<Spanned, Spanned>` that you can work with.
+By default, the questions are numbered, and the content is formatted with HTML.
+You may still need to add your own methods to allow interaction with certain elements such as links.
+
<a name="kotterknife"></a>
## Kotterknife