Skip to content

Commit f6bb688

Browse files
committed
Add a table of content
1 parent 9ecf78c commit f6bb688

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,20 @@
55
<a href="https://travis-ci.com/Colin-b/logging_json"><img alt="Build status" src="https://api.travis-ci.com/Colin-b/logging_json.svg?branch=master"></a>
66
<a href="https://travis-ci.com/Colin-b/logging_json"><img alt="Coverage" src="https://img.shields.io/badge/coverage-100%25-brightgreen"></a>
77
<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
8-
<a href="https://travis-ci.com/Colin-b/logging_json"><img alt="Number of tests" src="https://img.shields.io/badge/tests-0 passed-blue"></a>
8+
<a href="https://travis-ci.com/Colin-b/logging_json"><img alt="Number of tests" src="https://img.shields.io/badge/tests-11 passed-blue"></a>
99
<a href="https://pypi.org/project/logging_json/"><img alt="Number of downloads" src="https://img.shields.io/pypi/dm/logging_json"></a>
1010
</p>
1111

12-
This module provides a JSON formatter for the python [`logging`](https://docs.python.org/3/library/logging.html) module.
12+
This module provides a JSON formatter for the python [`logging`](https://docs.python.org/3/library/logging.html) module that will format to JSON formatted string.
13+
14+
Using this formatter allows to have the proper format for logging to `Splunk` or `ElasticSearch`, but it can also be used for logging to stdout as a string is issued.
15+
16+
- [Features](#features)
17+
- [Custom fields](#adding-additional-fields-and-values)
18+
- [dict logging](#logging-with-a-dictionary)
19+
- [str logging](#logging-with-anything-else-such-as-a-string)
20+
- [Configuration](#configuration)
21+
- [Using dictConfig](#using-loggingconfigdictconfig)
1322

1423
## Features
1524

0 commit comments

Comments
 (0)