Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
janpecha committed Dec 26, 2017
1 parent 3de9e1d commit 793bc42
Showing 1 changed file with 14 additions and 15 deletions.
29 changes: 14 additions & 15 deletions readme.md
Original file line number Diff line number Diff line change
@@ -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
<?php
Expand All @@ -23,22 +36,8 @@ $matcher->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)
Expand Down

0 comments on commit 793bc42

Please sign in to comment.