Skip to content

Commit

Permalink
Add installation and code of conduct to README
Browse files Browse the repository at this point in the history
  • Loading branch information
johnfraney committed May 19, 2019
1 parent 4d91634 commit 94d114b
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,14 @@ Flake8 Markdown lints [GitHub-style Python code blocks](https://help.github.com/

This package helps improve a Python project's documentation by ensuring that code samples are error-free.

## Installation

Flake8 Markdown can be installed from PyPI using `pip` or your package manager of choice:

```
pip install flake8-markdown
```

## Usage

### CLI
Expand Down Expand Up @@ -43,6 +51,10 @@ repos:
- id: flake8-markdown
```
## Code of Conduct
Everyone interacting in the project's codebases, issue trackers, chat rooms, and mailing lists is expected to follow the [PyPA Code of Conduct](https://www.pypa.io/en/latest/code-of-conduct/).
## History
### [0.1.0] - 2019-05-19
Expand Down

0 comments on commit 94d114b

Please sign in to comment.