<commit_before>[![Build Status](https://travis-ci.org/astronati/fantasy-football-calculator.svg?branch=master)](https://travis-ci.org/astronati/calculator)

# Fantasy Football Calculator
This library allows user to calculate the points that a team has reached after a soccer match. The total can be
altered through some bonus like the defense one.

## Installation
You can install the library and its dependencies using composer running:
```sh
$ composer require fantasy-football-calculator
```

## Documentation
The documentation is generated using [phpDocumentor](http://www.phpdoc.org/) and you can find it in
`[docs/api](http://astronati.github.io/fantasy-football-calculator/docs/api)`.

### Calculator
Run the following command to instantiate a calculator:
```php
$calculator = CalculatorFactory::create($quotations, $options);
```

#### getSum
```php
$total = $calculator->getSum($footballers);
```

#### getDefenseBonus
```php
$defenseBonus = $calculator->getDefenseBonus($footballers);
```

#### getFormationDetails
```php
$formationDetails = $calculator->getFormationDetails($footballers);
```

## Development
The environment requires [phpunit](https://phpunit.de/), that has been already included in the `dev-dependencies` of
the `composer.json`.

### Dependencies
To install all modules you just need to run following command from the root path:

```sh
$ composer install
```

### Documentation
Please use the following command to run the documentation from the root path:
```sh
$ ./vendor/phpdocumentor/phpdocumentor/bin/phpdoc -d ./src -t ./docs/api
```

### Testing
The directories structure within the `tests` folder reflects what is inside the `src` folder:
```
src
\---->[folder-name]
\-------->[file-name].php
tests
\---->[folder-name]
\-------->[file-name]Test.php
```

Execute following command to run the tests suite from the root path:
```sh
$ ./vendor/phpunit/phpunit/phpunit ./tests
```

## License
This package is released under the [MIT license](LICENSE.md).
<commit_msg>Updated Readme.md file<commit_after>[![Build Status](https://travis-ci.org/astronati/fantasy-football-calculator.svg?branch=master)](https://travis-ci.org/astronati/calculator)

# Fantasy Football Calculator
This library allows user to calculate the points that a team has reached after a soccer match. The total can be
altered through some bonus like the defense one.

## Installation
You can install the library and its dependencies using composer running:
```sh
$ composer require fantasy-football-calculator
```

## Documentation
The documentation is generated using [phpDocumentor](http://www.phpdoc.org/) and you can find it in
[docs/api](http://astronati.github.io/fantasy-football-calculator/docs/api).

### Calculator
Run the following command to instantiate a calculator:
```php
$calculator = CalculatorFactory::create($quotations, $options);
```

#### getSum
#### @param Array
#### @return integer
```php
$total = $calculator->getSum($footballers);
```

#### getDefenseBonus
##### @param Array
##### @return integer
```php
$defenseBonus = $calculator->getDefenseBonus($footballers);
```

#### getFormationDetails
##### @param Array
##### @return Array
```php
$formationDetails = $calculator->getFormationDetails($footballers);
```

## Development
The environment requires [phpunit](https://phpunit.de/), that has been already included in the `dev-dependencies` of
the `composer.json`.

### Dependencies
To install all modules you just need to run following command from the root path:

```sh
$ composer install
```

### Documentation
Please use the following command to run the documentation from the root path:
```sh
$ ./vendor/phpdocumentor/phpdocumentor/bin/phpdoc -d ./src -t ./docs/api
```

### Testing
The directories structure within the `tests` folder reflects what is inside the `src` folder:
```
src
\---->[folder-name]
\-------->[file-name].php
tests
\---->[folder-name]
\-------->[file-name]Test.php
```

Execute following command to run the tests suite from the root path:
```sh
$ ./vendor/phpunit/phpunit/phpunit ./tests
```

## License
This package is released under the [MIT license](LICENSE.md).

{'fraction_non_alphanumeric': 0.14871421639980592, 'fraction_numerical': 0.0, 'mean_word_length': 4.975362318840579, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 17, 'https://': 6, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '995156', 'n_tokens_mistral': 1262, 'n_tokens_neox': 1159, 'n_words': 392}