Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Preview your README as if it was on github
Ruby
branch: master

Merge pull request #1 from bigtiger/master

Small typo to be corrected
latest commit f046523dbd
@listrophy authored
Failed to load latest commit information.
lib Initial release
.gitignore Initial release
.rvmrc Initial release
Gemfile Initial release
Guardfile Initial release
MIT-LICENSE Initial release
README.md Fix Gemfile declaration syntax in README
Rakefile Initial release
TODO.md Initial release
guard-readme-on-github.gemspec Initial release

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.