Skip to content

Commit

Permalink
Add some documentation about the project
Browse files Browse the repository at this point in the history
  • Loading branch information
henriquemoody committed Dec 28, 2017
1 parent 8dde294 commit ab029e9
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,39 @@
[![License](https://img.shields.io/packagist/l/respect/stringifier.svg?style=flat-square)](https://packagist.org/packages/respect/stringifier)

Converts any PHP value into a string.

## Installation

Package is available on [Packagist](https://packagist.org/packages/respect/stringifier), you can install it
using [Composer](http://getcomposer.org).

```bash
composer require respect/stringifier
```

This library requires PHP >= 7.1.

## Feature Guide

Below a quick guide of how to use the library.

### Namespace import

Respect\Stringifier is namespaced, and you can make your life easier by importing
a single function into your context:

```php
use function Respect\Stringifier\stringify;
```

Stringifier was built using objects, the `stringify()` is a easy way to use it.

### Usage

Simply use the function to convert any value you want to:

```php
echo stringify($value);
```

To see more examples of how to use the library check the [integration tests](tests/integration).

0 comments on commit ab029e9

Please sign in to comment.