guard-readme-on-github

See how your README will look on GitHub without having to push!

Currently, it only handles markdown'ed READMEs titled "README.md" or "README.markdown" (case-insensitive).

Installation

Use bundler. This gem depends on guard, so make sure that's in your Gemfile as well:

Gemfile:


group :development do
  gem 'guard
  gem 'guard-readme-on-github'
end

Then run:


bundle

As with any other guard plugin, use the init command:


[bundle exec] guard init # necessary only the first time you set up guard
[bundle exec] guard init readme-on-github

Make sure guard is running:


guard

Modify your README (or just touch the modified-at flag) and view it in your browser:


open /tmp/markdown-preview.html