Skip to content

Commit

Permalink
minor cosmetic changes
Browse files Browse the repository at this point in the history
  • Loading branch information
llaville committed Dec 22, 2022
1 parent 4dcf039 commit b7719e0
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center">`phplint` is a tool that can speed up linting of php files by running several lint processes at once.</p>

![artboard 1](https://user-images.githubusercontent.com/1472352/38774811-3f780ab6-40a3-11e8-9a0a-a8d06d2c6463.jpg)
![artboard](https://github.com/overtrue/phplint/blob/8.0/artboard.png)

[![Release Status](https://github.com/overtrue/phplint/actions/workflows/build-phar.yml/badge.svg)](https://github.com/overtrue/phplint/actions/workflows/build-phar.yml)
[![Latest Stable Version](https://poser.pugx.org/overtrue/phplint/v/stable.svg)](https://packagist.org/packages/overtrue/phplint) [![Total Downloads](https://poser.pugx.org/overtrue/phplint/downloads.svg)](https://packagist.org/packages/overtrue/phplint) [![Latest Unstable Version](https://poser.pugx.org/overtrue/phplint/v/unstable.svg)](https://packagist.org/packages/overtrue/phplint) [![License](https://poser.pugx.org/overtrue/phplint/license.svg)](https://packagist.org/packages/overtrue/phplint)
Expand All @@ -18,25 +18,30 @@
- PHP >= 8.0
- Composer >= 2.0

> if you are using php 5.5, php 5.6 or php 7.x, please refer [the 7.4 branch](https://github.com/overtrue/phplint/tree/7.4).
> if you are using php 7.4, please refer [the 7.4 branch](https://github.com/overtrue/phplint/tree/7.4).
> if you are using php 8.1, please refer [the 8.1 branch](https://github.com/overtrue/phplint/tree/8.1).
> if you are using php 8.2, please refer [the 8.2 branch](https://github.com/overtrue/phplint/tree/8.2).

### Locally, if you have PHP

```shell
$ composer require overtrue/phplint: --dev -vvv
composer require overtrue/phplint: --dev -vvv
```

### Locally, if you only have Docker

```
```shell
docker pull overtrue/phplint:8.0
```

## Usage

### CLI

```shell
```text
Description:
Lint something
Expand Down Expand Up @@ -70,7 +75,7 @@ Options:
example:

```shell
$ ./vendor/bin/phplint ./ --exclude=vendor
./vendor/bin/phplint ./ --exclude=vendor
```

You can also define configuration as a file `.phplint.yml`:
Expand All @@ -88,7 +93,7 @@ memory_limit: -1
```
```shell
$ ./vendor/bin/phplint
./vendor/bin/phplint
```

By default, the command will read configuration from file `.phplint.yml` of path specified, you can use another filename by option: `--configuration=FILENAME` or `-c FILENAME`;
Expand Down Expand Up @@ -157,7 +162,7 @@ code-quality:lint-php:
Run this command using `overtrue/phplint:8.0` Docker image:

```
```shell
/root/.composer/vendor/bin/phplint ./ --exclude=vendor
```

Expand Down
Binary file added artboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b7719e0

Please sign in to comment.