<commit_before># PHP Lib Bootstrap

[![Latest Stable Version](https://poser.pugx.org/raphhh/php-lib-bootstrap/v/stable.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)
[![Build Status](https://travis-ci.org/Raphhh/php-lib-bootstrap.png)](https://travis-ci.org/Raphhh/php-lib-bootstrap)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/)
[![Code Coverage](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/1eaf3345-68ec-44ff-8fed-bcbd4721bb13/mini.png)](https://insight.sensiolabs.com/projects/1eaf3345-68ec-44ff-8fed-bcbd4721bb13)
[![Dependency Status](https://www.versioneye.com/user/projects/54062eb9c4c187ff6100006f/badge.svg?style=flat)](https://www.versioneye.com/user/projects/54062eb9c4c187ff6100006f)
[![Total Downloads](https://poser.pugx.org/raphhh/php-lib-bootstrap/downloads.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)
[![Reference Status](https://www.versioneye.com/php/raphhh:php-lib-bootstrap/reference_badge.svg?style=flat)](https://www.versioneye.com/php/raphhh:php-lib-bootstrap/references)
[![License](https://poser.pugx.org/raphhh/php-lib-bootstrap/license.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)

A bootstrap for a lib in PHP. Don't set, just code!  

This bootstrap will install all the basic files and settings to start a PHP library. 


## Installation


First, use composer to create your project. (Note that composer will also create all the repositories if they do not exist.)

```
$ composer create-project raphhh/php-lib-bootstrap path/to/my/project
```

Go into your project.

```
$ cd path/to/my/project
```

Finally, run PHPUnit to test the installation.

```
$ ./vendor/bin/phpunit
```

## Customisation

If tests are ok, that means you can start your project.
You just need to replace composer.json and README.md with your specific info.

After this customisation, just code.
<commit_msg>add documentation about samurai<commit_after># PHP Lib Bootstrap

[![Latest Stable Version](https://poser.pugx.org/raphhh/php-lib-bootstrap/v/stable.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)
[![Build Status](https://travis-ci.org/Raphhh/php-lib-bootstrap.png)](https://travis-ci.org/Raphhh/php-lib-bootstrap)
[![Scrutinizer Quality Score](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/)
[![Code Coverage](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/Raphhh/php-lib-bootstrap/)
[![SensioLabsInsight](https://insight.sensiolabs.com/projects/1eaf3345-68ec-44ff-8fed-bcbd4721bb13/mini.png)](https://insight.sensiolabs.com/projects/1eaf3345-68ec-44ff-8fed-bcbd4721bb13)
[![Dependency Status](https://www.versioneye.com/user/projects/54062eb9c4c187ff6100006f/badge.svg?style=flat)](https://www.versioneye.com/user/projects/54062eb9c4c187ff6100006f)
[![Total Downloads](https://poser.pugx.org/raphhh/php-lib-bootstrap/downloads.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)
[![Reference Status](https://www.versioneye.com/php/raphhh:php-lib-bootstrap/reference_badge.svg?style=flat)](https://www.versioneye.com/php/raphhh:php-lib-bootstrap/references)
[![License](https://poser.pugx.org/raphhh/php-lib-bootstrap/license.svg)](https://packagist.org/packages/raphhh/php-lib-bootstrap)

A bootstrap for a lib in PHP. Don't set, just code!  

This bootstrap will install all the basic files and settings to start a PHP library. 


## Installation

### With Samurai (recommended)

Just execute [Samurai](https://github.com/Raphhh/samurai) with 'lib' boostrap.

```
$ samurai new lib
```

### With Composer

First, use [Composer](https://getcomposer.org/) to create your project. (Note that composer will also create all the repositories if they do not exist.)

```
$ composer create-project raphhh/php-lib-bootstrap path/to/my/project
```

Go into your project.

```
$ cd path/to/my/project
```

Finally, run PHPUnit to test the installation.

```
$ ./vendor/bin/phpunit
```

If tests are ok, that means you can start your project.
You just need to replace composer.json and README.md with your specific info.

After this customisation, just code.

{'fraction_non_alphanumeric': 0.16166333110962863, 'fraction_numerical': 0.02935290193462308, 'mean_word_length': 5.2213001383125865, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 38, 'lorem ipsum': 0, 'www.': 8, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2289718', 'n_tokens_mistral': 1711, 'n_tokens_neox': 1573, 'n_words': 250}