diff --git a/README.md b/README.md index ad45695..2d07a73 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Here are a few features of this program : - compatible with Java 5 runtime - lightweight : requires only a few dependencies and few system resources - configuration compatible with logstash-forwarder - - lumberjack output + - lumberjack output (including zlib compression) ## Why ? @@ -15,6 +15,10 @@ Logstash-forwarder is written in go. This programming language is not available Logstash runs on java and provides a lumberjack output, but the file input doesn't run on all plaforms (for example AIX) and logstash requires a recent JVM. Moreover Logstash is heavier : big package and more system resources. -So logstash-forwarder-java is a solution for those who want a portable, lightweight log-shipper for their ELK stack. +So logstash-forwarder-java is a solution for those who want a portable, lightweight log shipper for their ELK stack. +## How to install it ? + +For the moment the only way to install logstash-forwarder-java is to download the maven project and run maven build. Next step is to distribute the logstash-forwarder-java jar and the lib directory located in the maven target directory. +I'll try to provide a tarball in the next releases.