docs(api): update readme

alisonmonteiro · May 12, 2018 · c5d10d8 · c5d10d8
1 parent 7446d90
commit c5d10d8
Showing 1 changed file with 33 additions and 5 deletions.
diff --git a/readme.md b/readme.md
@@ -1,15 +1,43 @@
-## shoe-size-converter
+# shoe-size-converter
 
-### usage
+> Convert your shoe size 👟
 
-##### converter(country, genre, size, [output]);
+## Usage
 
 ```javascript
 const converter = require('shoe-size-converter');
 
 converter('au', 'm', 4.5);
 //=> {eu: 37, br: 35, cm: 24, in: '9 3/8'}
 
-converter('uk', 'w', 6, ['br']);
-//=> {br: 37}
+converter('uk', 'w', 6, ['br', 'us']);
+//=> {br: 37, us: 6.5}
 ```
+
+## API
+
+### converter(location, genre, size, [output]);
+
+#### location
+Type: `string`
+
+Options: `us`, `ca`, `uk`, `au`, `eu`, `br`
+
+#### genre
+Type: `string`
+
+Options: `w`, `m`
+
+Default: `m`
+
+#### size
+Type: `string`
+
+Your shoe size based on `location`
+
+#### output
+Type: `Array`
+
+Default: `['eu', 'br', 'cm', 'in']`
+
+Options: `us`, `ca`, `uk`, `au`, `eu`, `br`, `cm`, `in`