Skip to content

Commit

Permalink
Divide installation procedures
Browse files Browse the repository at this point in the history
  • Loading branch information
mmicu committed Apr 17, 2022
1 parent 95b0f5d commit 058c145
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# editorconfig-checker.python

<p align="center">
<a href="https://pypi.org/project/editorconfig-checker/"><img src="https://img.shields.io/pypi/v/editorconfig-checker.svg?style=flat&logo=pypi" alt="PyPI Latest Release"></a>
<a href="https://pepy.tech/project/editorconfig-checker"><img src="https://pepy.tech/badge/editorconfig-checker" alt="Downloads"> </a>
Expand All @@ -9,23 +10,27 @@ A Python wrapper to provide a pip-installable [editorconfig-checker](https://git

Internally, this package provides a convenient way to download the pre-built `editorconfig-checker` binary for your particular platform.


## Installation
```
$ pip install . # from source code
$ pip install editorconfig-checker # from PyPI
```

- From source code:
```
pip install .
```
- From `PyPI`:
```
pip install editorconfig-checker
```

## Usage

After installation, the `ec` binary should be available in your environment (or `ec.exe` on Windows):

```
$ ec -version
ec -version
```


## Usage with the pre-commit git hooks framework

`editorconfig-checker` can be included as a hook for [pre-commit](https://pre-commit.com/).
The easiest way to get started is to add this configuration to your `.pre-commit-config.yaml`:

Expand Down

0 comments on commit 058c145

Please sign in to comment.