Skip to content

Commit

Permalink
Initial commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyespo committed Nov 17, 2012
0 parents commit 9bc5190
Show file tree
Hide file tree
Showing 3 changed files with 85 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .gitignore
@@ -0,0 +1,11 @@
# Environment-specific files such as configuration, logs, and setup
build/
temp/
local_config.py
*.pyc
*.egg-info

# Misc and OS files
Desktop.ini # Directory atttributes in Windows.
Thumbs.db # Picture thumbnail cache in Windows 98.
.DS_Store # Directory attributes in Mac OS X.
19 changes: 19 additions & 0 deletions LICENSE
@@ -0,0 +1,19 @@
Copyright (c) 2012 Joe Esposito

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.
55 changes: 55 additions & 0 deletions README.md
@@ -0,0 +1,55 @@
Grip -- Github Readme Instant Preview
=====================================

Render local readme files before sending off to Github.

[http://github.com/joeyespo/grip](http://github.com/joeyespo/grip)


What is this?
-------------

Grip is a server written in Python that uses the Github
[markup API](http://developer.github.com/v3/markdown/)
to render a local readme. The styles also come directly
from Github, so you'll know exactly how it will appear.

The package includes both a command-line interface
and a Python API.


Why do you need it?
-------------------

Sometimes you just want to see the exact readme
result before committing and pushing to Github.


Usage
-----

The command-line interface is simple. Visit the directory of your readme, then:

$ grip

Now open a browser and visit [`localhost:5000`](http://localhost:5000/)


API
---

You can access the API directly with Python, using it in your own projects:

from grip import serve

serve(directory='path-to-your-file')

Other functions include: `find_readme`, `render_content`, and `render_page`


Installation
------------

To install grip, simply:

$ pip install grip

0 comments on commit 9bc5190

Please sign in to comment.