Skip to content

Commit 37da5f6

Browse files
committed
doc: rephrase README and add maven central badge
1 parent 3810bc3 commit 37da5f6

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
11
LogUnit
22
=======
33

4-
A framework for unit-testing logging.
4+
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/io.github.netmikey.logunit/logunit-core/badge.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.netmikey.logunit/logunit-core)
5+
6+
A Java library for unit-testing logging.
57

68

79
## Purpose
810

911
Sometimes, writing specific information into its log(file) is an important part of an application's functionality. As such, it's probably a good idea to cover that behavior in the application's unit tests.
1012

11-
Although there are other solutions to achieve this (like e.g. encapsulate important logging into dedicated Java interfaces, inject mocks of those interfaces into the unit and test for the methods to be called), LogUnit aims at testing on a lower level, right within the logging framework. No matter how you generate your log messages in your project, if they end up in the popular [Slf4j](https://www.slf4j.org) library, you can use LogUnit (\*).
13+
Although there are other solutions to achieve this (like e.g. using mocks and test for the methods to be called), LogUnit aims at testing on another level: right within the logging framework, so you can still see all your logs while testing. No matter how you generate your log messages in your project, if they end up in the popular [Slf4j](https://www.slf4j.org) library, you can use LogUnit (\*).
1214

1315

1416
## Requirements

0 commit comments

Comments
 (0)