From 343be41a0e21a083a67fd302afdcba6acdb52442 Mon Sep 17 00:00:00 2001 From: John Fitzpatrick Date: Thu, 7 Dec 2017 22:44:26 +1100 Subject: [PATCH] Updated README.md with info regarding binaries. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 929f237..3853b44 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,20 @@ [![Scrutinizer Code Quality][ico-code-quality]][link-code-quality] [![Dependency Status][ico-dependencies]][link-dependencies] -A compact command line utility for checking YAML file syntax. Uses the parsing facility of the [Symfony Yaml Component](https://github.com/symfony/yaml). +A compact command line utility for checking YAML file syntax. Uses the parsing facility of the +[Symfony Yaml Component](https://github.com/symfony/yaml). ## Install -Via Composer: +Install as a project component with Composer (executable from the project's `vendor/bin` directory): ``` bash $ composer require j13k/yaml-lint ``` +Typically a binary edition (`yaml-lint.phar`) is also available for download with [each release](https://github.com/j13k/yaml-lint/releases). +This embeds the latest stable version of the Symfony Yaml component that is current at the time of the release. + ## Usage ``` bash