Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ericsizemore committed Jul 13, 2023
1 parent b8e03f9 commit 3b7898e
Showing 1 changed file with 30 additions and 3 deletions.
33 changes: 30 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Utility - Collection of various PHP utility functions.
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fericsizemore%2Futility.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fericsizemore%2Futility?ref=badge_shield)

[![Tests](https://github.com/ericsizemore/utility/actions/workflows/main.yml/badge.svg)](https://github.com/ericsizemore/utility/actions/workflows/main.yml)
[![Latest Stable Version](https://img.shields.io/packagist/v/esi/utility.svg)](https://packagist.org/packages/esi/utility)
[![Downloads per Month](https://img.shields.io/packagist/dm/esi/utility.svg)](https://packagist.org/packages/esi/utility)
[![License](https://img.shields.io/packagist/l/esi/utility.svg)](https://packagist.org/packages/esi/utility)

[Utility](http://github.com/ericsizemore/utility/) is (currently) a small collection of
useful functions that are aimed to make developers' lives just a tad bit easier.
Expand All @@ -15,6 +18,22 @@ useful functions that are aimed to make developers' lives just a tad bit easier.
$ composer require esi/utility
```

Then, within your project (if not already included), include composer's autoload. For example:

```php
<?php

require 'vendor/autoload.php';

use Esi\Utility\Utility;

$title = Utility::title('this is my title');

echo $title;

?>
```

### Standalone File

Simply drop `Utility.php` in any project and call `include 'src/Utility/Utility.php';`, where
Expand All @@ -29,6 +48,10 @@ include 'src/Utility/Utility.php';

use Esi\Utility\Utility;

$title = Utility::title('this is my title');

echo $title;

?>
```

Expand All @@ -39,6 +62,10 @@ use Esi\Utility\Utility;

use Esi\Utility\Utility;

$title = Utility::title('this is my title');

echo $title;

?>
```

Expand Down Expand Up @@ -72,7 +99,7 @@ Array

### Requirements

- Utility works with PHP 7.1.0 or above.
- Utility works with PHP 8.2.0 or above.

### Submitting bugs and feature requests

Expand Down Expand Up @@ -125,7 +152,7 @@ branches for both of these features and send two requests.

### Author

Eric Sizemore - <admin@secondversion.com> - <http://www.secondversion.com>
Eric Sizemore - <admin@secondversion.com> - <https://www.secondversion.com>

### License

Expand Down

0 comments on commit 3b7898e

Please sign in to comment.