From 166441086a2a06da3f108011ad4e2222bd823000 Mon Sep 17 00:00:00 2001 From: Toni Melisma Date: Thu, 15 Apr 2021 12:59:18 +0300 Subject: [PATCH] Clarify README --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ed52b5a..42251e2 100644 --- a/README.md +++ b/README.md @@ -44,9 +44,13 @@ log drain for Heroku, see [https://github.com/tonimelisma/golang-heroku-log-drai ## Caveats RFC5424 defines a way to transmit structured data messages in addition to the more typical free-form text log messages. -This structured data is not parsed in any way. I've never actually seen any system use the data. +This library does not parse this structured data. It is provided as-is in the ``Message`` field of the struct, just like +regular unstructured log messages. I've never actually seen any system use the structured data, and most implementations +break RFC5424 by transmitting unstructured data instead of structured in the seventh field, and thus parsing it as +structured would break compatibility with most systems. ## Maintenance -Although I will not update the software, I will attempt to answer opened -issues or PRs in a reasonable timeframe. \ No newline at end of file +I consider this library feature-complete for my use cases and don't foresee much activity in the repository. +However, *this software is still actively maintained*. Any issues or PRs will be dealt with in a reasonable +amount of time. \ No newline at end of file