README.md in mockdata-0.1.1 vs README.md in mockdata-0.1.2
- old
+ new
@@ -1,100 +1,200 @@
-See https://github.com/evaneykelen/mockdata/wiki/Documentation for documentation.
+[](https://badge.fury.io/rb/mockdata)
+
+### Random data generator for test purposes
+
+_Note: All dummy data is work-place safe (IMO) but use at your own risk._
+
+#### Animal names
+
+`Mockdata::Animals.horse => "Sally"`
+
+`Mockdata::Animals.pet => "Cute Tiger"`
+
+`Mockdata::Animals.critter => "Ferret"`
+
+`Mockdata::Animals.dog => "Dodger"`
+
+`Mockdata::Animals.cat => "Sammy"`
+
+#### Locations
+
+`Mockdata::Locations.city_latitude_longitude => ["Miami", 25.809781975840405, -80.255126953125]`
+
+`Mockdata::Locations.city => ["Belgrade", "Serbia"]`
+
+`Mockdata::Locations.streetname => "Back Wood Quay"`
+
+`Mockdata::Locations.island => "The Coral Cay"`
+
+`Mockdata::Locations.airport => "Medcalf Field Airport"`
+
+#### Names
+
+`Mockdata::Names.company => "Purplegale Limited"`
+
+`Mockdata::Names.business_type => "Telephone Apparatus Manufacturing`
+
+`Mockdata::Names.project => "Brave Neutron"`
+
+`Mockdata::Names.hotel => "Farmhouse Hotel"`
+
+`Mockdata::Names.occupation => "Airport Tower Controller"`
+
+#### Numbers
+
+Return random number between 1 and 3 including 1 and 3
+
+`Mockdata::Numbers.random_between_min_max_inclusive(1..3) => 3`
+
+Return random number between 1 and 3 excluding 1 and 3
+
+`Mockdata::Numbers.random_between_min_max_exclusive(1..3) => 2`
+
+Return array with 3 elements, filled with random numbers between 1 and 10
+
+`Mockdata::Numbers.random_number_array(1..10, 3) => [9,1,4]`
+
+Return array with 3 elements, filled with random numbers picked from [1, 2, 3, 4]
+
+`Mockdata::Numbers.choose_from_array_with_possible_duplicates([1, 2, 3, 4], 3) => [4, 2, 2]`
+
+`Mockdata::Numbers.choose_from_array_without_duplicates([1, 2, 3, 4], 3) => [4, 2, 3]`
+
+#### People
+
+The first and last names contain English, European, Asian and other names.
+
+`Mockdata::People.first_and_last_name => "David Allen"`
+
+`Mockdata::Names.first_name => "David"`
+
+`Mockdata::Names.last_name => "Allen"`
+
+`Mockdata::People.superhero => "Raving Warrior"`
+
+`Mockdata::People.elf => "Relboron Meldin"`
+
+`Mockdata::People.robot => "Sensory Network Defense Android"`
+
+#### Time-zones
+
+Return a random time-zone:
+
+`Mockdata::TimeZones.pick => {"Minsk"=>"Europe/Minsk"}`
+
+#### Words
+
+Return random words:
+
+`Mockdata::Words.one => "rocket"`
+
+`Mockdata::Words.two => "silk verb"`
+
+`Mockdata::Words.three => "thin moment pool"`
+
+`Mockdata::Words.four => "onto surprise note hall"`
+
+`Mockdata::Words.pick(10) => "well shovel slick doctor poke seek threat bone together obey"`
+
+Return between 2 and 10 random words separated by spaces:
+
+`Mockdata::Words.some(2..10) => "beam scan grown tape course thimble newscast main asleep"`