From fd2f6e68b5754c121a18a80bd78ccec484b23e86 Mon Sep 17 00:00:00 2001 From: David Buchmann Date: Tue, 23 Aug 2016 09:27:46 +0200 Subject: [PATCH] update readme --- README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d07fca9..6c251d5 100644 --- a/README.md +++ b/README.md @@ -21,12 +21,15 @@ $ composer require php-http/mock-client ## Usage -Use this client in a testing framework. +This client does not actually send requests to any server. + +Instead it stores the request and returns a pre-set response or throws an exception. This client is useful for unit +testing code that depends on a HTTPlug client to send requests and receive responses. ## Documentation -Please see the [official documentation](http://docs.php-http.org). +Please see the [mock client](http://docs.php-http.org/en/latest/clients/mock-client.html) section in the [official documentation](http://docs.php-http.org). ## Testing @@ -48,7 +51,7 @@ If you discover any security related issues, please contact us at [security@php- ## Credits -Thanks to [David de Boer](https://github.com/ddeboer) for implementing this client. +Thanks to [David de Boer](https://github.com/ddeboer) for implementing the mock client. ## License