Skip to content

Commit

Permalink
Improves documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
raphaelstolt committed Sep 13, 2023
1 parent db5cbe4 commit 4b6b348
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ composer require --dev stolt/lean-package-validator
```

As of release `v1.9.0` it's also possible to install and use the LeanPackageValidator via a PHAR [file](https://github.com/raphaelstolt/lean-package-validator/releases/tag/v1.9.0).
Therefor download a released version i.e. v1.9.0 and move it to `/usr/local/bin` as shown next.

``` bash
wget https://github.com/raphaelstolt/lean-package-validator/releases/download/v1.9.0/lean-package-validator.phar
mv lean-package-validator.phar /usr/local/bin/lean-package-validator
```

## Usage
Run the LeanPackageValidator CLI within or against a project/micro-package directory and it will validate the [export-ignore](https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes#Exporting-Your-Repository) entries present in a `.gitattributes` file against a set of common repository artifacts. If no `.gitattributes` file is present it will suggest to create one.
Expand Down

0 comments on commit 4b6b348

Please sign in to comment.