README.md in fluent-plugin-out-http-1.3.3 vs README.md in fluent-plugin-out-http-1.3.4
- old
+ new
@@ -1,11 +1,41 @@
# fluent-plugin-out-http, a plugin for [Fluentd](http://fluentd.org)
A generic [fluentd][1] output plugin for sending logs to an HTTP endpoint.
+**NOTE:** This plugin name is overlapped from Fluentd core plugin which name is `out_http`. But core plugin does not provide buffered/non-buffered switch and batch/non-batch request switch. If you want to use these switch features. Please consider to use this plugin.
+
[](https://travis-ci.org/fluent-plugins-nursery/fluent-plugin-out-http)
+## Installation
+
+### For bundler
+
+Write the following line in Gemfile:
+
+```gemfile
+gem "fluent-plugin-out-http"
+```
+
+and then,
+
+```console
+$ bundle install
+```
+
+### for fluentd
+
+```console
+$ fluent-gem install fluent-plugin-out-http
+```
+
+### For td-agent
+
+```console
+$ td-agent-gem install fluent-plugin-out-http
+```
+
## Configuration options
<match *>
@type http
endpoint_url http://localhost.local/api/
@@ -43,5 +73,13 @@
Heavily based on [fluent-plugin-growthforecast][2]
[1]: http://fluentd.org/
[2]: https://github.com/tagomoris/fluent-plugin-growthforecast
[3]: https://github.com/sabottenda/fluent-plugin-bufferize
+
+## How to release
+
+1. Update `gem.version` of the `gemspec` file.
+1. Update `CHANGELOG.md`.
+1. Commit them.
+1. `$ bundle exec rake release`
+ * It will add and push the tag, and publish the gem.