diff --git a/README b/README deleted file mode 100644 index 205ffd8..0000000 --- a/README +++ /dev/null @@ -1,3 +0,0 @@ -The syslog4j fork from Graylog2. This is used since 0.10.0. The original code was very "special" and no actions were taken to improve it. This is planned to be replaced completely in future versions. - -http://syslog4j.org/ diff --git a/README.md b/README.md new file mode 100644 index 0000000..662dac0 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +syslog4j +======== + +Syslog4j provides client and server implementations of the BSD Syslog protocol +(RFC 3164) and the draft "structured syslog" protocol (RFC Draft). + +## Warning + +This is a repackaged fork used in [Graylog2](http://graylog2.org/), as the +original package has no recent versions published to Maven Central. + +Some modifications have been applied to fix bugs we ran into. + +Original source code from: http://syslog4j.org/ (does not work anymore) + +## License + +This project is licensed under the [LGPL](http://www.gnu.org/licenses/lgpl-2.1.html).