Skip to content

Commit 2a734c8

Browse files
committed
* Improve README
1 parent d175e05 commit 2a734c8

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Extension to Tomcat logging that will format the contents as JSON to be better compatible with logging environments for microservices.
44

5+
## TOC
6+
7+
1. [Example](#example)
8+
2. [Installation](#installation)
9+
3. [Customization](#customization)
10+
4. [FAQ](#faq)
11+
5. [Contributing](#contributing)
12+
6. [License](#license)
13+
514
## Example
615

716
If everything is configured correctly you will see output like this on our console:
@@ -67,3 +76,29 @@ You can either specify a system property or environment variable to change the b
6776
|------|-------------|
6877
| `org.echocat.tjl.JsonFormatter` | Formats the whole output as JSON. One entry per line. |
6978
| `org.echocat.tjl.TextFormatter` | Formats every entry per line in a simple way - better for local debugging. |
79+
80+
## FAQ
81+
82+
#### How to activate debug output temporary?
83+
84+
```bash
85+
LOG_LEVEL=debug bin/catalina.sh run
86+
```
87+
88+
#### How to make output temporarily better readable?
89+
90+
```bash
91+
LOG_FORMAT=text bin/catalina.sh run
92+
```
93+
94+
## Contributing
95+
96+
tomcat-json-logging is an open source project by [echocat](https://echocat.org).
97+
So if you want to make this project even better, you can contribute to this project on [Github](https://github.com/echocat/tomcat-json-logging)
98+
by [fork us](https://github.com/echocat/tomcat-json-logging/fork).
99+
100+
If you commit code to this project, you have to accept that this code will be released under the [license](#license) of this project.
101+
102+
## License
103+
104+
See the [LICENSE](LICENSE) file.

0 commit comments

Comments
 (0)