Skip to content

Commit

Permalink
move example to README's top
Browse files Browse the repository at this point in the history
  • Loading branch information
dasilvacontin committed Jun 15, 2015
1 parent 4b3586a commit 98f5435
Showing 1 changed file with 22 additions and 21 deletions.
43 changes: 22 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,11 @@ Enhance your GitHub repo's markdown files.
`gh-sauce` parses issues and usernames from markdown files and automatically converts them into links. Your markdown will remain clean and easy to read since the URLs will be listed at the end of the file.


## Install

```bash
$ npm install -g gh-sauce
```


## Usage

```
Usage: gh-sauce [options] <file ...>
Options:
-h, --help output usage information
-V, --version output the version number
```


## Example

Before:

```
```markdown

# CHANGELOG

Expand All @@ -42,7 +23,8 @@ Before:
```

After:
```

```markdown

# CHANGELOG

Expand All @@ -61,6 +43,25 @@ After:

```


## Install

```bash
$ npm install -g gh-sauce
```


## Usage

```
Usage: gh-sauce [options] <file ...>
Options:
-h, --help output usage information
-V, --version output the version number
```

## API

_(Coming soon)_
Expand Down

0 comments on commit 98f5435

Please sign in to comment.