Update documentation

jbueza · Jul 6, 2013 · 96d81ba · 96d81ba
1 parent 870dc88
commit 96d81ba
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 8 deletions.
diff --git a/META-INF/MANIFEST.MF b/META-INF/MANIFEST.MF
@@ -0,0 +1,2 @@
+Manifest-Version: 1.0
+
diff --git a/README.md b/README.md
@@ -1,21 +1,38 @@
 # Faker.java
 
-A tool for generating fake data. This is inspired by Faker.js, Faker.rb.
+![687474703a2f2f696d6775722e636f6d2f4b69696e512e706e67](https://f.cloud.github.com/assets/25766/756187/4a2b7b6e-e5f4-11e2-96a5-e7a01e5c51be.png)
+
+A tool for generating fake data. This is inspired by [Faker.js](https://github.com/Marak/Faker.js), [Faker.rb](https://github.com/stympy/faker).
 
 ## Usage
 
+
+### Person API
+
 ```java
+Faker faker = new Faker();
+
+String name = faker.Person().fullName();                // Jaime Bueza
+String firstName = faker.Person().firstName();          // John
+String lastName = faker.Person().lastName();            // Smith
+```
+
+### Company API
 
+```java
 Faker faker = new Faker();
 
-String firstName = faker.firstName();
-String lastName = faker.lastName();
-String address = faker.address();
-String firstName = faker.firstName();
-String firstName = faker.firstName();
+String companyName = faker.Company().name();                // Adaptive Infrastructures Inc.
+```
+
+### Lorem Ipsum API
+
+```java
+Faker faker = new Faker();
 
+String paragraphs = faker.LoremIpsum().paragraphs(2);                // Generates two paragraphs
 ```
 
-## Download
+## License
 
-Download the jars
+MIT.