Skip to content

Commit

Permalink
A more-to-the-point README
Browse files Browse the repository at this point in the history
  • Loading branch information
dasilvacontin committed Aug 30, 2015
1 parent 024bec2 commit 3fb1901
Showing 1 changed file with 21 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# gh-sauce
# gh-sauce
[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][daviddm-url]][daviddm-image]
Expand All @@ -7,29 +7,28 @@

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 (in alphanumeric order) at the end of the file.


## Example

Before:

```markdown

$ cat CHANGELOG.md
# CHANGELOG

## 2.1.1 / 11 June 2015

- Bugfix for using values from view's context prototype #442 by @phillipj.
- Only display result of master branch on travis badge by @nikolas.
- Upgrade assertion library for proper string diffs #459 by @dasilvacontin.

```

After:

```markdown
$ gh-sauce CHANGELOG.md
# Dressing CHANGELOG.md with some gh-sauce...

- [x] "CHANGELOG.md" was dressed with gh-sauce

Done! 🍧
```

```markdown
$ cat CHANGELOG.md
# CHANGELOG

## 2.1.1 / 11 June 2015
Expand All @@ -44,9 +43,9 @@ After:
[@dasilvacontin]: https://github.com/dasilvacontin
[@nikolas]: https://github.com/nikolas
[@phillipj]: https://github.com/phillipj

```

`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 (in alphanumeric order) at the end of the file.

## Install

Expand Down Expand Up @@ -80,7 +79,7 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.

## License

Copyright (c) 2015 David da Silva Contín. Licensed under the MIT license.
MIT © [David da Silva](http://dasilvacont.in)



Expand All @@ -94,3 +93,11 @@ Copyright (c) 2015 David da Silva Contín. Licensed under the MIT license.
[daviddm-image]: https://david-dm.org/dasilvacontin/gh-sauce
[coveralls-url]: https://coveralls.io/r/dasilvacontin/gh-sauce?branch=master
[coveralls-image]: https://coveralls.io/repos/dasilvacontin/gh-sauce/badge.svg?branch=master

[#442]: https://github.com/dasilvacontin/gh-sauce/issues/442
[#459]: https://github.com/dasilvacontin/gh-sauce/issues/459

[@dasilvacontin]: https://github.com/dasilvacontin
[@nikolas]: https://github.com/nikolas
[@phillipj]: https://github.com/phillipj

0 comments on commit 3fb1901

Please sign in to comment.