diff --git a/README.md b/README.md new file mode 100644 index 0000000..ceeb214 --- /dev/null +++ b/README.md @@ -0,0 +1,7 @@ +# heka-riemann-encoder + +This is an encoder plugin for [heka](https://github.com/mozilla-services/heka) that allows heka to forward events to [Riemann](http://riemann.io). This allows users to leverage the existing TCP output plugin (and TLS support) provided by heka. + +## Credits + +The general gist of riemann communication was based off of [raidman](https://github.com/amir/raidman).