summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/icrowley/fake/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/icrowley/fake/README.md')
-rw-r--r--vendor/github.com/icrowley/fake/README.md90
1 files changed, 90 insertions, 0 deletions
diff --git a/vendor/github.com/icrowley/fake/README.md b/vendor/github.com/icrowley/fake/README.md
new file mode 100644
index 000000000..3c1fe8a1b
--- /dev/null
+++ b/vendor/github.com/icrowley/fake/README.md
@@ -0,0 +1,90 @@
+[![Build Status](https://img.shields.io/travis/icrowley/fake.svg?style=flat)](https://travis-ci.org/icrowley/fake) [![Godoc](http://img.shields.io/badge/godoc-reference-blue.svg?style=flat)](https://godoc.org/github.com/icrowley/fake) [![license](http://img.shields.io/badge/license-MIT-red.svg?style=flat)](https://raw.githubusercontent.com/icrowley/fake/master/LICENSE)
+
+Fake
+====
+
+Fake is a fake data generator for Go (Golang), heavily inspired by the forgery and ffaker Ruby gems.
+
+## About
+
+Most data and methods are ported from forgery/ffaker Ruby gems.
+For the list of available methods please look at https://godoc.org/github.com/icrowley/fake.
+Currently english and russian languages are available.
+
+Fake embeds samples data files unless you call `UseExternalData(true)` in order to be able to work without external files dependencies when compiled, so, if you add new data files or make changes to existing ones don't forget to regenerate data.go file using `github.com/mjibson/esc` tool and `esc -o data.go -pkg fake data` command (or you can just use `go generate` command if you are using Go 1.4 or later).
+
+## Install
+
+```shell
+go get github.com/icrowley/fake
+```
+
+## Import
+
+```go
+import (
+ "github.com/icrowley/fake"
+)
+```
+
+## Documentation
+
+Documentation can be found at godoc:
+
+https://godoc.org/github.com/icrowley/fake
+
+## Test
+To run the project tests:
+
+```shell
+cd test
+go test
+```
+
+## Examples
+
+```go
+name := fake.FirstName()
+fullname := fake.FullName()
+product := fake.Product()
+```
+
+Changing language:
+
+```go
+err := fake.SetLang("ru")
+if err != nil {
+ panic(err)
+}
+password := fake.SimplePassword()
+```
+
+Using english fallback:
+
+```go
+err := fake.SetLang("ru")
+if err != nil {
+ panic(err)
+}
+fake.EnFallback(true)
+password := fake.Paragraph()
+```
+
+Using external data:
+
+```go
+fake.UseExternalData(true)
+password := fake.Paragraph()
+```
+
+### Author
+
+Dmitry Afanasyev,
+http://twitter.com/i_crowley
+dimarzio1986@gmail.com
+
+
+### Maintainers
+
+Dmitry Moskowski
+https://github.com/corpix