# ReadmeTester

Tests code in readme files, generates the readme if they are successful.

## TODO

* uh... make this a real readme
* release as gem
* extract magic_comments and rspec out into their own gems
* set up input files so they don't need a .mountain_berry_fields in their name if given a -o flag
* set up input flag so `mountain_berry_fields -s` will list the test strategies

## Installation

Add this line to your application's Gemfile:

    gem 'readme_tester'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install readme_tester

## Usage

TODO: Write usage instructions here

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request


# RSpec strategy for Mountain Berry Fields

As this is an official plugin, it is documented as part of the main [MountainBerryFields](https://github.com/JoshCheek/mountain_berry_fields) code.

If you have it installed (`gem install mountain_berry_fields-rspec`), then it will be automatically loaded by MountainBerryFields, no further steps are necessary.
If you are using Bundler, make sure it is in your Gemfile. If using Rubygems, set it as a development dependency
([example](https://github.com/JoshCheek/mountain_berry_fields/blob/be751536c8b0f94c84b09167fa83616b94b13b12/mountain_berry_fields.gemspec#L22)).

Update readme to point at main MBF and talk about dependencies
Update readme to point at main MBF and talk about dependencies
