Skip to content

Commit

Permalink
improve readme (#90)
Browse files Browse the repository at this point in the history
Simplify the message in the first section of the project README to focus
on the main features of the library rather than just the types of
targets that are supported.
  • Loading branch information
goatshriek authored Jul 21, 2020
1 parent 5392c88 commit 865a3b6
Showing 1 changed file with 16 additions and 14 deletions.
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,22 @@
[![Apache 2.0 License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0-ff69b4.svg)](https://github.com/goatshriek/stumpless/blob/latest/docs/CODE_OF_CONDUCT.md)

A logging library built with a
[vision](https://github.com/goatshriek/stumpless/blob/latest/docs/vision.md):
a rich and intuitive interface, standards compliance, fast performance, and a
small footprint.

Currently stumpless offers [standardized](https://tools.ietf.org/html/rfc5424)
logging to the following targets:
* network servers ([UDP](https://tools.ietf.org/html/rfc5426) or
[TCP](https://tools.ietf.org/html/rfc6587) over IPv4 or IPv6)
* files
* streams
* Linux sockets
* the Windows Event Log
* character buffers
A C logging library built for high performance and a rich feature set. Check
out our
[vision](https://github.com/goatshriek/stumpless/blob/latest/docs/vision.md)
to see what we are all about!

Stumpless offers a robust set of features to make logging in C faster and
easier:
* cross-platform builds on Linux, Windows, MacOSX, Cygwin, and more
* easy logging to network targets like Splunk or rsyslog servers
* logging that can be removed at compile-time for zero performance impact
* interoperability with standard syslog daemons and library functions
* an extensive unit testing suite and continuous integration
* easy-access
[documentation](https://goatshriek.github.io/stumpless/docs/c/latest/index.html)
and
[examples](https://github.com/goatshriek/stumpless/tree/latest/docs/examples)

## Basic Logging Functions
The simplest way to get started is to use the `stumplog` function as a direct
Expand Down

0 comments on commit 865a3b6

Please sign in to comment.