<commit_before># Installation

## Requirements
Before installing **Akismet for PHP**, you need to make sure you have [PHP](https://www.php.net)
and [Composer](https://getcomposer.org), the PHP package manager, up and running.

!!! warning
    Akismet for PHP requires PHP >= **7.4.0**.
    
You can verify if you're already good to go with the following commands:

```shell
php --version
# PHP 7.4.1 (cli) (built: Dec 17 2019 19:23:59) ( NTS Visual C++ 2017 x64 )

composer --version
# Composer version 1.9.1 2019-11-01 17:20:17
```

!!! info
    If you plan to play with the package sources, you will also need
    [Robo](https://robo.li) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).

## Installing with Composer package manager

### 1. Install it
From a command prompt, run:

```shell
composer require cedx/akismet
```

### 2. Import it
Now in your [PHP](https://www.php.net) code, you can use:

```php
<?php
use Akismet\{Author, Blog, CheckResult, Comment, CommentType};
use Akismet\Http\{Client, ClientException};
```

### 3. Use it
See the [usage information](usage.md).
<commit_msg>Updated the documentation<commit_after># Installation

## Requirements
Before installing **Akismet for PHP**, you need to make sure you have [PHP](https://www.php.net)
and [Composer](https://getcomposer.org), the PHP package manager, up and running.

!!! warning
    Akismet for PHP requires PHP >= **7.4.0**.
    
You can verify if you're already good to go with the following commands:

```shell
php --version
# PHP 7.4.3 (cli) (built: Feb 18 2020 17:29:57) ( NTS Visual C++ 2017 x64 )

composer --version
# Composer version 1.9.3 2020-02-04 12:58:49
```

!!! info
    If you plan to play with the package sources, you will also need
    [Robo](https://robo.li) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material).

## Installing with Composer package manager

### 1. Install it
From a command prompt, run:

```shell
composer require cedx/akismet
```

### 2. Import it
Now in your [PHP](https://www.php.net) code, you can use:

```php
<?php
use Akismet\{Author, Blog, CheckResult, Comment, CommentType};
use Akismet\Http\{Client, ClientException};
```

### 3. Use it
See the [usage information](usage.md).

{'fraction_non_alphanumeric': 0.14451382694023193, 'fraction_numerical': 0.039250669045495096, 'mean_word_length': 4.063205417607223, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 10, 'lorem ipsum': 0, 'www.': 4, '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': '69419', 'n_tokens_mistral': 809, 'n_tokens_neox': 726, 'n_words': 268}