From db6901ecc49cdca70987dc9ad1ea9d450adc50c3 Mon Sep 17 00:00:00 2001 From: Jian Chen Date: Thu, 6 Feb 2020 17:39:44 +0800 Subject: [PATCH] add usage to README.md --- README.md | 37 ++++++++++++++++--------------------- 1 file changed, 16 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index e0b9855..a5ccafb 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,21 @@ This is a plugin for [Logstash](https://github.com/elastic/logstash). It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way. -## Documentation - -Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elastic.co/guide/en/logstash/current/). - -- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive -- For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide - -## Need Help? - -Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum. +## Usage + +

+output {
+  splunk {
+    url => "https://localhost:8080/services/collector/event/1.0"
+    # HTTP Event Collector token
+    token => "xxxxxxx-xxxx-xxxx-xxxx-xxxxxx"
+    is_batch => true
+    mapping => {
+     "event" => "%{message}"
+    }
+  }
+}
+
## Developing @@ -85,14 +90,4 @@ bin/logstash-plugin install --no-verify bin/plugin install --no-verify ``` -- Start Logstash and proceed to test the plugin - -## Contributing - -All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin. - -Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here. - -It is more important to the community that you are able to contribute. - -For more information about contributing, see the [CONTRIBUTING](https://github.com/elastic/logstash/blob/master/CONTRIBUTING.md) file. \ No newline at end of file +- Start Logstash and proceed to test the plugin \ No newline at end of file