This commit is contained in:
John Bintz 2012-06-26 09:17:27 -04:00
parent f91faa48f4
commit 5fa59b1f76
2 changed files with 11 additions and 26 deletions

View File

@ -1,29 +1,14 @@
# Sharkfrown
# Preview ur markdowns
TODO: Write a gem description
```
gem install sharkfrown
cd /my/project/with/markdown/files
sharkfrown
```
## Installation
Open `http://localhost:6789/` and away you go!
Add this line to your application's Gemfile:
## How?!
gem 'sharkfrown'
`Rack::Directory` and a really simple Rack app that processes Markdown w/ syntax highlighting from Pygments.
And then execute:
$ bundle
Or install it yourself as:
$ gem install sharkfrown
## 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

View File

@ -4,8 +4,8 @@ require File.expand_path('../lib/sharkfrown/version', __FILE__)
Gem::Specification.new do |gem|
gem.authors = ["John Bintz"]
gem.email = ["john@coswellproductions.com"]
gem.description = %q{TODO: Write a gem description}
gem.summary = %q{TODO: Write a gem summary}
gem.description = %q{Stupid-simple Rack-based Markdown browser with syntax highlighting.}
gem.summary = %q{Stupid-simple Rack-based Markdown browser with syntax highlighting.}
gem.homepage = ""
gem.files = `git ls-files`.split($\)