diff --git a/README.md b/README.md index 727c4f5b..90dccfd4 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,21 @@ class Foo { } ``` +Besides standard `%s` placeholders inside the format string, you can use +other custom ones, which help formatting common values faster: + + * `%[file]s` --- absolute file name ➜ file name relative to current directory + * `%[text]s` --- any string ➜ pretty looking text, short enough, and escaped + * `%[exception]s` --- `Exception` ➜ stacktrace + * `%[list]s` --- `Iterable` ➜ pretty formatted list, in one line + * `%[size]s` --- size in bytes ➜ Kb, Mb, Gb, Tb, and so on + * `%[msec]s` --- milliseconds ➜ ms, sec, min, hours, etc. + * `%[nano]s` --- nanoseconds ➜ µs, ms, sec, min, hours, etc. + * `%[type]s` --- `Class` ➜ name of it + * `%[secret]s` --- any string ➜ stars + +You are welcome to suggest your own "decors". + ## How to contribute? Fork the repository, make changes, submit a pull request.