diff options
author | Allan Wang <me@allanwang.ca> | 2017-08-07 22:20:57 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-08-07 22:20:57 -0700 |
commit | 02e1dbc84425b0ac7f771c82f70444f742397452 (patch) | |
tree | 05e978e7588e30ce653428671f3d9f5df5397385 /core/README.md | |
parent | 187d8e64dc7189f63707d154166867084662dbe3 (diff) | |
download | kau-02e1dbc84425b0ac7f771c82f70444f742397452.tar.gz kau-02e1dbc84425b0ac7f771c82f70444f742397452.tar.bz2 kau-02e1dbc84425b0ac7f771c82f70444f742397452.zip |
Release 3.3.0 (#32)3.3.0
* Rewrite Logger (#29)
* Remove dependency on timber
* Update logger
* Reorder throwabl
* Fix lint
* Update readme
* Blank target
* Create Zip (#30)
* Finish zips with tests
* Finalize
* Update changelog
* Add log hooks
* Open most logging functions
* Remap kpref items (#31)
* Update readme
* Generate files and prepare release
* Kpref -
Diffstat (limited to 'core/README.md')
-rw-r--r-- | core/README.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/core/README.md b/core/README.md index 6796082..4cb68d0 100644 --- a/core/README.md +++ b/core/README.md @@ -13,7 +13,7 @@ * [CollapsibleViewDelegate](#collapsible-view-delegate) * [Swipe](#swipe) * [Debounce](#debounce) -* [Timber Logger](#timber-logger) +* [KAU Logger](#kau-logger) * [Email Builder](#email-builder) * [Extension Functions](#extension-functions) * [Lazy Resettable](#lazy-resettable) @@ -58,7 +58,7 @@ The object inherits the initializer method `fun initialize(c: Context, preferenc There is also a `reset()` method to clear the local values and have them retrieve from the SharedPreference again. In shared preferences, we often require a boolean that returns true once, so we can use it to showcase views or display prompts on the first load. -Kpref supports special preferences like these through the `KPrefSingleDelgate` +KPref supports special preferences like these through the `KPrefSingleDelgate` It can be used in a KPref like so: @@ -193,11 +193,14 @@ KAU offers extensions to easily convert or create functions into debouncables. Simply call `debounce` and specify your interval on an existing function, or with a new function. -## Timber Logger +## KAU Logger -[Timber](https://github.com/JakeWharton/timber)'s DebugTree uses the tag to specify the current class that is being logged. -To add the tag directly in the message, create an object that extends the TimberLogger class with the tag name as the argument. -Along with the timber methods (`v`, `i`, `d`, `e`), Timber Logger also supports `eThrow` to wrap a String in a throwable +`KauLogger` can be extended by an object to implement a logger with a permanent tag. +It's methods are the same as the main logger, along with the following: +* Logging methods have two inputs, the main text and private text. +If private text is disabled (default), it will not be logged. +* The loggers have toggles to enable logging as a whole and to filter out priorities that we wish to ignore. +* Has some other functions, like logging the current thread. ## Email Builder |