Skip to content

Commit

Permalink
Readme: fences.
Browse files Browse the repository at this point in the history
  • Loading branch information
joeyespo committed Dec 4, 2012
1 parent 643ab19 commit dd751c4
Showing 1 changed file with 12 additions and 6 deletions.
18 changes: 12 additions & 6 deletions README.md
Expand Up @@ -22,16 +22,20 @@ Installation

To install grip, simply:

$ pip install grip
```bash
$ pip install grip
```


Usage
-----

To render the readme of a repository:

$ cd myrepo
$ grip [port]
```bash
$ cd myrepo
$ grip [port]
```

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

Expand All @@ -41,9 +45,11 @@ 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', port=8080)
```python
from grip import serve

serve(directory='path-to-your-file', port=8080)
```

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

Expand Down

0 comments on commit dd751c4

Please sign in to comment.