<commit_before>
![hashids](http://www.hashids.org.s3.amazonaws.com/public/img/hashids.png "Hashids")

======

Full Documentation
-------

A small PHP class to generate YouTube-like ids from numbers. Read documentation at [http://hashids.org/php](http://hashids.org/php)

![hashids](https://secure.travis-ci.org/ivanakimov/hashids.php.png "Hashids")

Installation
-------

You can either `require()` the lib yourself, or use [Composer](http://getcomposer.org) (packagist has [hashids/hashids](https://packagist.org/packages/hashids/hashids) package).

In your `composer.json` file use:

``` json
{
    "require": {
        "hashids/hashids": "1.0.0"
    }
}
```

And run: `php composer.phar install`. After that you can require the autoloader and use Hashids:

``` php
<?php

require_once 'vendor/autoload.php'
$hashids = new Hashids\Hashids('this is my salt');
```

Example Usage
-------
<commit_msg>updating readme<commit_after>
![hashids](http://www.hashids.org.s3.amazonaws.com/public/img/hashids.png "Hashids")

======

Full Documentation
-------

A small PHP class to generate YouTube-like ids from numbers. Read documentation at [http://hashids.org/php](http://hashids.org/php)

![hashids](https://secure.travis-ci.org/ivanakimov/hashids.php.png "Hashids")

Installation
-------

You can either `require()` the lib yourself, or use [Composer](http://getcomposer.org) (packagist has [hashids/hashids](https://packagist.org/packages/hashids/hashids) package).

In your `composer.json` file use:

``` json
{
    "require": {
        "hashids/hashids": "1.0.0"
    }
}
```

And run: `php composer.phar install`. After that you can require the autoloader and use Hashids:

``` php
<?php

require_once 'vendor/autoload.php'
$hashids = new Hashids\Hashids('this is my salt');
```

Updating from v0.3 to 1.0?
-------

Read the `CHANGELOG` at the bottom of this readme!

Example Usage
-------

{'fraction_non_alphanumeric': 0.17724867724867724, 'fraction_numerical': 0.006349206349206349, 'mean_word_length': 3.775252525252525, 'pattern_counts': {'":': 4, '<': 5, '<?xml version=': 0, '>': 3, 'https://': 4, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6998865', 'n_tokens_mistral': 663, 'n_tokens_neox': 651, 'n_words': 159}