Preview your README as if it was on github
Ruby
Latest commit f046523 Apr 4, 2012 @listrophy Merge pull request #1 from bigtiger/master
Small typo to be corrected
Permalink
Failed to load latest commit information.
lib Initial release Jan 31, 2012
.gitignore Initial release Jan 31, 2012
.rvmrc Initial release Jan 31, 2012
Gemfile Initial release Jan 31, 2012
Guardfile Initial release Jan 31, 2012
MIT-LICENSE Initial release Jan 31, 2012
README.md Fix Gemfile declaration syntax in README Apr 4, 2012
Rakefile Initial release Jan 31, 2012
TODO.md Initial release Jan 31, 2012
guard-readme-on-github.gemspec Initial release Jan 31, 2012

README.md

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

Setup

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

Usage

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

Author