From 793bc422205cadd39d7f97fc41304ad4d5b2dff8 Mon Sep 17 00:00:00 2001 From: Jan Pecha Date: Tue, 26 Dec 2017 20:00:28 +0100 Subject: [PATCH] Updated README --- readme.md | 29 ++++++++++++++--------------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/readme.md b/readme.md index b630541..3f2faf2 100644 --- a/readme.md +++ b/readme.md @@ -1,8 +1,21 @@ # FileMatcher -## Usage +[![Build Status](https://travis-ci.org/czproject/file-matcher.svg?branch=master)](https://travis-ci.org/czproject/file-matcher) + + +## Installation + +[Download a latest package](https://github.com/czproject/file-matcher/releases) or use [Composer](http://getcomposer.org/): + +``` +composer require czproject/file-matcher +``` + +`CzProject\FileMatcher` requires PHP 5.4.0 or later. + +## Usage ``` php matchMask('.git', $masks, TRUE); // returns TRUE $matcher->matchMask('.gitignore', $masks); // return FALSE $matcher->matchMask('temp/cache', $masks, TRUE); // returns TRUE $matcher->matchMask('log/2016', $masks, TRUE); // returns FALSE - ``` - -Installation ------------- - -[Download a latest package](https://github.com/czproject/file-matcher/releases) or use [Composer](http://getcomposer.org/): - -``` -composer require [--dev] czproject/file-matcher -``` - -`CzProject\FileMatcher` requires PHP 5.4.0 or later. - - ------------------------------ License: [New BSD License](license.md)