Skip to content

Commit

Permalink
add usage to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Jian Chen committed Feb 6, 2020
1 parent b349e3e commit db6901e
Showing 1 changed file with 16 additions and 21 deletions.
37 changes: 16 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

<pre><code>
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}"
}
}
}
</code></pre>

## Developing

Expand Down Expand Up @@ -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.
- Start Logstash and proceed to test the plugin

0 comments on commit db6901e

Please sign in to comment.