README.md in logstash-output-email-0.1.3 vs README.md in logstash-output-email-0.1.4
- old
+ new
@@ -20,62 +20,53 @@
### 1. Plugin Developement and Testing
#### Code
- To get started, you'll need JRuby with the Bundler gem installed.
-- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization.
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
- Install dependencies
```sh
bundle install
```
#### Test
+- Update your dependencies
+
```sh
-bundle exec rspec
+bundle install
```
-The Logstash code required to run the tests/specs is specified in the `Gemfile` by the line similar to:
-```ruby
-gem "logstash", :github => "elasticsearch/logstash", :branch => "1.5"
-```
-To test against another version or a local Logstash, edit the `Gemfile` to specify an alternative location, for example:
-```ruby
-gem "logstash", :github => "elasticsearch/logstash", :ref => "master"
-```
-```ruby
-gem "logstash", :path => "/your/local/logstash"
-```
+- Run tests
-Then update your dependencies and run your tests:
-
```sh
-bundle install
bundle exec rspec
```
### 2. Running your unpublished Plugin in Logstash
#### 2.1 Run in a local Logstash clone
-- Edit Logstash `tools/Gemfile` and add the local plugin path, for example:
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
```ruby
gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
```
-- Update Logstash dependencies
+- Install plugin
```sh
-rake vendor:gems
+bin/plugin install --no-verify
```
- Run Logstash with your plugin
```sh
bin/logstash -e 'filter {awesome {}}'
```
At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
#### 2.2 Run in an installed Logstash
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
- Build your plugin gem
```sh
gem build logstash-filter-awesome.gemspec
```
- Install the plugin from the Logstash home
@@ -88,8 +79,8 @@
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 me that you are able to contribute.
+It is more important to the community that you are able to contribute.
-For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.
\ No newline at end of file