boxxo/README.md

38 lines
710 B
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 🧺 Boxxo A Fun Box in XO
Welcome to the **most useless-yet-somehow-useful** PHP module on the internet.
## What does it do?
- Contains a box.
- May squeak.
- Occasionally throws errors if you shake it.
- Fails with style.
## Installation
```bash
composer require projects/boxxo
````
## Usage
```php
use Projects\Boxxo\Snack;
use Projects\Boxxo\Test\Surprise;
echo Snack::squeak(); // Outputs: UwU from the boxxo 💜
$boom = new Surprise();
$boom->crash(); // 🐿️💥
```
## Warning
Opening the box may or may not unleash quantum squirrels.
We take no responsibility for multiverse overlap, existential dread, or kernel panics.
## License
MIT Because chaos is best served legally.