From 150cc4d11a7d002cb365226e73b5c465256a7bc8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20Sz=C3=A9pe?= Date: Mon, 22 Jul 2019 15:48:26 +0200 Subject: [PATCH] Proper readme --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index fa90e7fa..1fb87b4a 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,11 @@ -You can find documentation in the [wiki](https://github.com/bovigo/vfsStream/wiki). +# vfsStream -Also you might want to check [vfsStream examples](https://github.com/bovigo/vfs-stream-examples). +[![Build Status](https://secure.travis-ci.org/bovigo/vfsStream.png)](http://travis-ci.org/bovigo/vfsStream) [![Build Status Windows](https://ci.appveyor.com/api/projects/status/51mo891raqc4uh8t?svg=true)](https://ci.appveyor.com/project/mikey179/vfsstream) [![Coverage Status](https://coveralls.io/repos/github/bovigo/vfsStream/badge.svg)](https://coveralls.io/github/bovigo/vfsStream) [![Latest Stable Version](https://poser.pugx.org/mikey179/vfsStream/version.png)](https://packagist.org/packages/mikey179/vfsStream) [![Latest Unstable Version](https://poser.pugx.org/mikey179/vfsStream/v/unstable.png)](//packagist.org/packages/mikey179/vfsStream) + +vfsStream is a stream wrapper for a virtual file system that may be helpful in unit tests to mock the real file system. It can be used with any unit test framework, like PHPUnit or SimpleTest. +### Documentation -[![Build Status](https://secure.travis-ci.org/bovigo/vfsStream.png)](http://travis-ci.org/bovigo/vfsStream) [![Build Status Windows](https://ci.appveyor.com/api/projects/status/51mo891raqc4uh8t?svg=true)](https://ci.appveyor.com/project/mikey179/vfsstream) [![Coverage Status](https://coveralls.io/repos/github/bovigo/vfsStream/badge.svg)](https://coveralls.io/github/bovigo/vfsStream) +See the [wiki](https://github.com/bovigo/vfsStream/wiki). -[![Latest Stable Version](https://poser.pugx.org/mikey179/vfsStream/version.png)](https://packagist.org/packages/mikey179/vfsStream) [![Latest Unstable Version](https://poser.pugx.org/mikey179/vfsStream/v/unstable.png)](//packagist.org/packages/mikey179/vfsStream) +Also you might want to check [vfsStream examples](https://github.com/bovigo/vfs-stream-examples).