Skip to content

Commit

Permalink
Update README: add a few lines about library.
Browse files Browse the repository at this point in the history
  • Loading branch information
Aliance committed Feb 6, 2017
1 parent e564b92 commit 544676c
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,20 @@ Simple bitmask implementation
[![Build Status](https://travis-ci.org/Aliance/Bitmask.svg?branch=master)](https://travis-ci.org/Aliance/Bitmask)
[![Code Coverage](https://scrutinizer-ci.com/g/Aliance/Bitmask/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Aliance/Bitmask/?branch=master)

Installation
About
---

For install library you need to modify your composer configuration file
Bitmask is a simple PHP implementation of bitwise operations for creating masks.
Can be used for some flags implementation.
Currently supported PHP version: >= 5.5

```
"aliance/bitmask": "*"
```
Installation
---

And just run installation command
Install the latest version with composer:

```
$ composer.phar install
```bash
$ composer require aliance/bitmask
```

Usage
Expand Down Expand Up @@ -49,13 +50,13 @@ For completely tests running just call `phpunit` command from `./vendor/bin`

```
Aliance/Bitmask $ ./vendor/bin/phpunit
PHPUnit 4.8.27 by Sebastian Bergmann and contributors.
PHPUnit 4.8.35 by Sebastian Bergmann and contributors.
........
...........
Time: 85 ms, Memory: 4.00MB
Time: 68 ms, Memory: 4.25MB
OK (8 tests, 92 assertions)
OK (11 tests, 100 assertions)
```

License
Expand Down

0 comments on commit 544676c

Please sign in to comment.