Skip to content

Commit 678112e

Browse files
committed
Added changelog and example code
1 parent 46fe8a8 commit 678112e

File tree

2 files changed

+21
-0
lines changed

2 files changed

+21
-0
lines changed

CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Changelog
2+
3+
## 1.0.0 (21 Aug 2019)
4+
5+
Initial release

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,31 @@ $ composer require mintware-de/streams
1515

1616
## 📄 FileStream
1717
Provides read / write access for files.
18+
```php
19+
use \MintWare\Streams\FileStream;
20+
$stream = new FileStream($filename, $readable = true, $writable = true);
21+
```
1822

1923
## 💻 MemoryStream
2024
With this implementation you can read data from and write data to the memory.
25+
```php
26+
use \MintWare\Streams\MemoryStream;
27+
$stream = new MemoryStream($initialData = '');
28+
```
2129

2230
## 📥 InputStream
2331
Provides read-only access for the `php://input` resource. This holds for example the raw HTTP request.
32+
```php
33+
use \MintWare\Streams\InputStream;
34+
$stream = new InputStream();
35+
```
2436

2537
## 📤 OutputStream
2638
Provides write-only access for the `php://output` resource.
39+
```php
40+
use \MintWare\Streams\OutputStream;
41+
$stream = new OutputStream();
42+
```
2743

2844
## 🧪 Unit Tests
2945
```shell script

0 commit comments

Comments
 (0)