on master help sign in
More README tweaks
commitd1f5c9745952f9e7c663fedb2851a1b595da62a5 authorOzgun Ataman <ozgun.ataman@soostone.com> dateMon 7 Mar 2016, 12:17 (11 years ago) parent19fad18
1 file changed+21−3
katip/README.md+21−3
katip/README.md+21−3
@@ -16,15 +16,33 @@ Kâtip (pronounced kah-tip) is the Turkish word for scribe.
1616 add context that will be automatically merged in with existing log
1717 context.
1818
19−* *Easy to Use:* Katip was designed to be easily integrated into
20− existing systems. By using a typeclass for logging facilities,
19+* *Easy to Integration:* Katip was designed to be easily integrated
20+ into existing monads. By using typeclasses for logging facilities,
2121 individual subsystems and even libraries can easily add their own
2222 namespacing and context without having any knowledge of their
2323 logging environment.
2424
25+* *Practical Use:* Katip comes with a set of convenience facilities
26+ built-in, so it can be used without much headache even in small
27+ projects.
28+
29+ * A `Handle` backend for logging to files in simple settings.
30+
31+ * A `AnyLogPayload` key-value type that makes it easy to log
32+ structured columns on the fly without having to define new data
33+ types.
34+
35+ * A `Monadic` interface where logging namespace can be obtained
36+ from the monad context.
37+
38+ * Multiple variants of the fundamental logging functions for
39+ optionally including fields and line-number information.
40+
2541* *Extensible:* Can be easily extended (even at runtime) to output to
2642 multiple backends at once (known as scribes). See
27− `katip-elasticsearch` as an example.
43+ `katip-elasticsearch` as an example. Backends for other forms of
44+ storage are trivial to write, including both hosted database systems
45+ and SaaS logging providers.
2846
2947* *Debug-Friendly:* Critical details for monitoring production systems
3048 such as host, PID, thread id, module and line location are