Skip to content

Commit

Permalink
Gem skeleton and README
Browse files Browse the repository at this point in the history
  • Loading branch information
adamlogic committed Nov 19, 2012
0 parents commit aae054d
Show file tree
Hide file tree
Showing 8 changed files with 107 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .gitignore
@@ -0,0 +1,17 @@
*.gem
*.rbc
.bundle
.config
.yardoc
Gemfile.lock
InstalledFiles
_yardoc
coverage
doc/
lib/bundler/man
pkg
rdoc
spec/reports
test/tmp
test/version_tmp
tmp
4 changes: 4 additions & 0 deletions Gemfile
@@ -0,0 +1,4 @@
source 'https://rubygems.org'

# Specify your gem's dependencies in github-preview.gemspec
gemspec
22 changes: 22 additions & 0 deletions LICENSE.txt
@@ -0,0 +1,22 @@
Copyright (c) 2012 Adam McCrea

MIT License

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 changes: 32 additions & 0 deletions README.md
@@ -0,0 +1,32 @@
# github-preview

Say you're writing a README for your project, or any other Markdown that will
eventually be displayed on Github. You want a way to preview this locally
before you push it.

`github-preview` opens a preview of your Markdown file in a browser. It uses
Github styling and automatically refreshes everytime you save your source.

## Installation

```shell
gem install github-preview
```

## Usage

`github-preview` is a command-line utility.

```shell
github-preview README.md
```

This will open your default browser with a live-updating preview.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
1 change: 1 addition & 0 deletions Rakefile
@@ -0,0 +1 @@
require "bundler/gem_tasks"
19 changes: 19 additions & 0 deletions github-preview.gemspec
@@ -0,0 +1,19 @@
# -*- encoding: utf-8 -*-
lib = File.expand_path('../lib', __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require 'github-preview/version'

Gem::Specification.new do |gem|
gem.name = "github-preview"
gem.version = Github::Preview::VERSION
gem.authors = ["Adam McCrea"]
gem.email = ["adam@adamlogic.com"]
gem.description = %q{Command line utility for previewing Markdown files with Github styling}
gem.summary = gem.description
gem.homepage = "http://github.com/newcontext/github-preview"

gem.files = `git ls-files`.split($/)
gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
gem.require_paths = ["lib"]
end
7 changes: 7 additions & 0 deletions lib/github-preview.rb
@@ -0,0 +1,7 @@
require "github-preview/version"

module Github
module Preview
# Your code goes here...
end
end
5 changes: 5 additions & 0 deletions lib/github-preview/version.rb
@@ -0,0 +1,5 @@
module Github
module Preview
VERSION = "0.0.1"
end
end

0 comments on commit aae054d

Please sign in to comment.