Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nadar authored Dec 16, 2017
1 parent b5b79da commit eee7fbf
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,14 @@ This project fixes your Markdown files in order to render them nicely with GitHu
Currently built in features:

+ Replace all tabs with 4 spaces.
+ Fixes none breaking spaces problem [github/markup issue problem description](https://github.com/github/markup/issues/1054#issuecomment-300061967).
+ Fixes none breaking spaces problem ([github/markup issue problem description](https://github.com/github/markup/issues/1054#issuecomment-300061967)).

![GitHub Markdown Fixer in Action](screenshot.png)

## Usage

Add the `nadar/github-markdown-fixer` to your project, within the `require-dev` section:

> IF YOU GET A MINIMUM STABILITY / COMPOSER ERROR USE: `"minimum-stability" : "RC"` IN YOUR COMPOSER.JSON.
```sh
composer require nadar/github-markdown-fixer --dev
```
Expand All @@ -33,4 +31,4 @@ Go into your Terminal an run the Fixer:

|argument|description
|--------|----------
|--dry |run command in dry mode, does not change file contents.
|--dry |run command in dry mode, does not change file contents, but display which files would change.

0 comments on commit eee7fbf

Please sign in to comment.