diff --git a/README.md b/README.md index 2edcca0b..df0a4a8a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ Nestlog is a lightweight header-only library for console logging. +## Features + +- easy-to-read format uses indenting to show call structure. + indentation has user-controlled upper limit to preserve readability with + deeply nested call graphs +- colorized output using vt100 color codes (ansi or xterm) +- automatically captures + displays timestamp, function name and code location. + supports several function-name formats to reflect tradeoff readability for precision +- application code may issue logging code that contains embedded newlines; + logger preserves indentation. +- logger is 'truthy', so you only pay for formatting for entry points that are enabled. + ## Examples ### 1