README.md in nanoc-external-1.0.1 vs README.md in nanoc-external-1.0.2

- old
+ new

@@ -1,36 +1,35 @@ -[![Build Status](https://travis-ci.org/nanoc/nanoc-external.png)](https://travis-ci.org/nanoc/nanoc-external) -[![Code Climate](https://codeclimate.com/github/nanoc/nanoc-external.png)](https://codeclimate.com/github/nanoc/nanoc-external) -[![Coverage Status](https://coveralls.io/repos/nanoc/nanoc-external/badge.png?branch=master)](https://coveralls.io/r/nanoc/nanoc-external) - # nanoc-external -This provides a filter that allows [nanoc](http://nanoc.ws) to process content by executing an external program. +This provides a filter that allows [Nanoc](http://nanoc.ws) to process content by executing an external program. -Maintained by [lifepillar](https://github.com/lifepillar). - ## Installation -`gem install nanoc-external` +Add `nanoc-external` to the `nanoc` group of your Gemfile: +```ruby +group :nanoc do + gem 'nanoc-external' +end +``` + ## Usage +Call the `:external` filter and pass the command to execute as the `:exec` argument. For example: + ```ruby -filter :external, :exec => 'command-name' +filter :external, exec: 'wc' ``` -The only requirement is that the external command must be -able to receive its input from STDIN and it must send its -output to STDOUT. +The external command must receive input from standard input (“stdin”) and must send its output to standard out (“stdout”). -Options passed to this filter will be passed on to the -external command. For example: +Options passed to this filter will be passed on to the external command. For example: ```ruby -filter :external, exec: 'multimarkdown', options: => %w(--accept --mask --labels --smart) +filter :external, exec: 'multimarkdown', options: %w(--accept --mask --labels --smart) ``` -If the executable is not in your PATH, use its full path: +You can also pass the full path of the executable: ```ruby filter :external, exec: '/opt/local/bin/htmlcompressor' ```