<commit_before>MaintenanceScreen
=====

Maintenance screen for any project in PHP.

# Installation

```bash
composer require luar/maintenance-screen
```

To use it in your project simply include the following in the index.php of the website:

```php
<?php 

use Luar\MaintenanceScreen;

MaintenanceScreen::load(array(
	'enable' => true,
	'visible_hosts' => array()
));
```

# Documentation
The following options can be sent to load() in an associative array.

```
'enable' => false, // enable or disable the screen

// ip addresses that can continue to see the web even though it is active
'visible_hosts' => array (
'localhost',
'192.168.1.33'
), 

// optionals
'flag' => 'maintenance.flag', // Is activated or deactivated based on the existence of the indicated file
'img_path' => 'maintenance.jpg', // Show the indicated image
'title' => 'Maintenance title', // Show the title written
'text' => 'This site is in testing.', // Shows the indicated text
'css_path' => 'style.css', // Includes custom style sheet
'bgcolor' => 'black' // Modifies the background of the screen
```<commit_msg>Actualizamos readme<commit_after>
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)

### Installation

```bash
composer require luar/maintenance-screen
```

### Usage

To use it in your project simply include the following in the index.php of the website:

```php
<?php 

use Luar\MaintenanceScreen;

MaintenanceScreen::load(array(
	'enable' => true,
	'visible_hosts' => array()
));
```

### Documentation
The following options can be sent to load() in an associative array.

```
'enable' => false, // enable or disable the screen

// ip addresses that can continue to see the web even though it is active
'visible_hosts' => array (
'localhost',
'192.168.1.33'
), 

// optionals
'flag' => 'maintenance.flag', // Is activated or deactivated based on the existence of the indicated file
'img_path' => 'maintenance.jpg', // Show the indicated image
'title' => 'Maintenance title', // Show the title written
'text' => 'This site is in testing.', // Shows the indicated text
'css_path' => 'style.css', // Includes custom style sheet
'bgcolor' => 'black' // Modifies the background of the screen
```
{'fraction_non_alphanumeric': 0.13583032490974728, 'fraction_numerical': 0.008122743682310469, 'mean_word_length': 4.4338235294117645, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 23, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 2, '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': '6552287', 'n_tokens_mistral': 684, 'n_tokens_neox': 641, 'n_words': 254}