diff --git a/README.md b/README.md index 72fca4309..124b5d70d 100644 --- a/README.md +++ b/README.md @@ -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