<commit_before>Package Skeleton
================

[![Build Status](https://travis-ci.org/SammyK/PKGName.png?branch=master)](https://travis-ci.org/SammyK/PKGName)
[![Total Downloads](https://poser.pugx.org/SammyK/PKGName/downloads.png)](https://packagist.org/packages/SammyK/PKGName)
[![Latest Stable Version](https://poser.pugx.org/SammyK/PKGName/v/stable.png)](https://packagist.org/packages/SammyK/PKGName)

**Replace PKGName with your own package name in the above URLs**

:package_description


Installation
------------

Via Composer

``` json
{
    "require": {
        "sammyk/:package_name": "~1.0"
    }
}
```


Usage
-----

``` php
$skeleton = new SammyK\Skeleton();
echo $skeleton->echoPhrase('Hello, World!');

```<commit_msg>Added MIT badge. Added navigation to top.<commit_after>Package Skeleton
================

[![Build Status](https://travis-ci.org/SammyK/PKGName.png?branch=master)](https://travis-ci.org/SammyK/PKGName)
[![Total Downloads](https://poser.pugx.org/sammyk/pkg-name/downloads.png)](https://packagist.org/packages/sammyk/pkg-name)
[![Latest Stable Version](https://poser.pugx.org/sammyk/pkg-name/v/stable.png)](https://packagist.org/packages/sammyk/pkg-name)
[![License](https://poser.pugx.org/sammyk/pkg-name/license.png)](https://packagist.org/packages/sammyk/pkg-name)


:package_description

- [Installation](#installation)
- [Usage](#usage)
- [Testing](#testing)
- [Contributing](#contributing)
- [Credits](#credits)
- [License](#license)


Installation
------------

Add the :package_name package to your `composer.json` file:

``` json
{
    "require": {
        "sammyk/:package_name": "~1.0"
    }
}
```


Usage
-----

``` php
$skeleton = new SammyK\Skeleton();
echo $skeleton->echoPhrase('Hello, World!');

```
{'fraction_non_alphanumeric': 0.22488584474885845, 'fraction_numerical': 0.00228310502283105, 'mean_word_length': 4.495297805642633, 'pattern_counts': {'":': 4, '<': 3, '<?xml version=': 0, '>': 5, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, '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': '6730199', 'n_tokens_mistral': 677, 'n_tokens_neox': 643, 'n_words': 80}