Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yaroslavche committed Jun 5, 2019
1 parent 393f7fd commit 2f67fb7
Showing 1 changed file with 6 additions and 17 deletions.
23 changes: 6 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,29 +51,13 @@ $assoc->getByKey('other'); // true
$assoc->isFlag2(); // true
```

### Installing
## Installing

Install package via [composer](https://getcomposer.org/)
```bash
composer require yaroslavche/bitmask
```

### Doctrine custom mapping type
For using Doctrine mapping type as `bitmask` need to register type. See example [in Doctrine documentation](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/cookbook/custom-mapping-types.html)

For Symfony need only add custom type in Doctrine config:
```yaml
# config/packages/doctrine.yaml

doctrine:
dbal:
types:
bitmask: BitMask\Doctrine\Types\BitMaskType

```

[Usage example](https://medium.com/@yaroslav429/symfony-4-doctrine-custom-mapping-type-1c8ff679f4c1)

## Scripts:
#### Tests
PHPUnit
Expand All @@ -86,6 +70,11 @@ Infection
$ composer infection
$ ./vendor/bin/infection --min-msi=50 --min-covered-msi=70
```
#### BC
```bash
$ composer bccheck
$ ./vendor/bin/roave-backward-compatibility-check
```
#### Benchmarks
```bash
$ composer benchmarks
Expand Down

0 comments on commit 2f67fb7

Please sign in to comment.