Skip to content

Commit ab029e9

Browse files
committed
Add some documentation about the project
1 parent 8dde294 commit ab029e9

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,39 @@
88
[![License](https://img.shields.io/packagist/l/respect/stringifier.svg?style=flat-square)](https://packagist.org/packages/respect/stringifier)
99

1010
Converts any PHP value into a string.
11+
12+
## Installation
13+
14+
Package is available on [Packagist](https://packagist.org/packages/respect/stringifier), you can install it
15+
using [Composer](http://getcomposer.org).
16+
17+
```bash
18+
composer require respect/stringifier
19+
```
20+
21+
This library requires PHP >= 7.1.
22+
23+
## Feature Guide
24+
25+
Below a quick guide of how to use the library.
26+
27+
### Namespace import
28+
29+
Respect\Stringifier is namespaced, and you can make your life easier by importing
30+
a single function into your context:
31+
32+
```php
33+
use function Respect\Stringifier\stringify;
34+
```
35+
36+
Stringifier was built using objects, the `stringify()` is a easy way to use it.
37+
38+
### Usage
39+
40+
Simply use the function to convert any value you want to:
41+
42+
```php
43+
echo stringify($value);
44+
```
45+
46+
To see more examples of how to use the library check the [integration tests](tests/integration).

0 commit comments

Comments
 (0)