Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jonmast committed Nov 25, 2016
1 parent 6b43f2b commit a522e1f
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ development.

### NOTE

* While Faker generates data at random, returned values are not guaranteed to be unique.
* While Faker generates data at random, returned values are not guaranteed to be unique by default.
You must explicity specify when you require unique values, see details [here](#ensuring-unique-values).
* This is the `master` branch of Faker and may contain changes that are not yet released.
Please refer the README of your version for the available methods.
List of all versions is [available here](https://github.com/stympy/faker/releases).
Expand Down Expand Up @@ -76,6 +77,12 @@ Faker::Name.name #=> "Christophe Bartell"
Faker::Internet.email #=> "kirsten.greenholt@corkeryfisher.info"
```

####Ensuring unique values
Prefix your method call with `unique`. For example:
```ruby
Faker::Name.unique.name # This will return a unique name every time it is called
```

### Faker::Address
-----------------

Expand Down Expand Up @@ -878,6 +885,7 @@ Faker::Food.spice #=> "Caraway Seed"
Faker::Food.measurement #=> "1/4 tablespoon"
```


Customization
------------
Since you may want to make addresses and other types of data look different
Expand Down

0 comments on commit a522e1f

Please sign in to comment.