Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Preview your README as if it was on github

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .rvmrc
Octocat-spinner-32 Gemfile
Octocat-spinner-32 Guardfile
Octocat-spinner-32 MIT-LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 TODO.md
Octocat-spinner-32 guard-readme-on-github.gemspec
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

Something went wrong with that request. Please try again.