From 52bc166adb1dd0aa038a0452ebdeddaf461eb1d0 Mon Sep 17 00:00:00 2001 From: Seredenko Dmitry Date: Thu, 20 Sep 2018 20:59:01 +0200 Subject: [PATCH] Update README --- README.md | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index bccaa9f..a38f210 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,22 @@ - [![GoDoc](https://godoc.org/github.com/Selvatico/go-mocket?status.svg)](https://godoc.org/github.com/Selvatico/go-mocket) [![Build Status](https://travis-ci.org/Selvatico/go-mocket.svg?branch=master)](https://travis-ci.org/Selvatico/go-mocket) [![Go Report Card](https://goreportcard.com/badge/github.com/Selvatico/go-mocket)](https://goreportcard.com/report/github.com/Selvatico/go-mocket) ### Go-Mocket Go-Mocket is library inspired by [DATA-DOG/go-sqlmock](https://github.com/DATA-DOG/go-sqlmock) -As inspiration library it is implementation of [sql/driver](https://godoc.org/database/sql/driver) interface but at the same time follows different approaches and has only similar API. -This library helps to mock any DB connection also with [jinzhu/gorm](https://github.com/jinzhu/gorm) and it was main goal to create it +As inspiration library, it is the implementation of [sql/driver](https://godoc.org/database/sql/driver) interface but at the same time follows different approaches and has only a similar API. +This library helps to mock any DB connection also with [jinzhu/gorm](https://github.com/jinzhu/gorm), and it was the main goal to create it List of features in the library: * Mock `INSERT`, `UPDATE`, `SELECT`, `DELETE` * Support of transactions -* 2 API's to use - `chaining` and via specifying whole mock object +* 2 API's to use - `chaining` and via specifying a whole mock object * Matching by prepared statements arguments -* You will not require to change anything inside you code to start using this library +* You don't require to change anything inside your code to start using this library * Ability to trigger exceptions -* Attach callbacks to mocked response to add additional check or modify response +* Attach callbacks to mocked response to add an additional check or modify a response -**NOTE** Please be aware that driver catches SQL without DB specifics. Generating of queries is done by *sql* package +**NOTE**, Please be aware that driver catches SQL without DB specifics. Generating of queries is done by *SQL* package #### Install @@ -30,11 +29,11 @@ go get github.com/Selvatico/go-mocket There are two possible ways to use `mocket`: * Chaining API -* Specifying `FakeResponse` object with all fields manually. Could be useful for cases when mocks stored separately as list of FakeResponses. +* Specifying `FakeResponse` object with all fields manually. Could be useful for cases when mocks stored separately as the list of FakeResponses. ##### Enabling driver -Somewhere in you code to setup a tests +Somewhere in your code to set up a tests ```go import ( @@ -54,7 +53,7 @@ func SetupTests() { } ``` -Now if use singleton instance of DB it will use everywhere mocked connection. +Now if use singleton instance of DB, it uses everywhere mocked connection. ##### Chain usage @@ -114,5 +113,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -