From a6aed946a4a08f9c7763776743a36205328c68e4 Mon Sep 17 00:00:00 2001 From: Ken Hibino Date: Mon, 11 Jul 2016 20:57:29 -0700 Subject: [PATCH] chore(README): Make punctuation and casing consistent --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 21945630..e1941cfb 100644 --- a/README.md +++ b/README.md @@ -88,22 +88,22 @@ export default SimpleForm ### Props for `PlacesAutocomplete` #### value -Type: `String` +Type: `String`, Required: `true` Value displayed in the input field #### setAddress -Type: `function` +Type: `Function`, Required: `true` Please see the example above #### classNames -Type: `object` +Type: `Object`, Require: `false` -You can give a custom css classes to elements +You can give a custom css classes to elements. Accepted keys are `container`, `label`, `input`, `autocompleteContainer` ```js @@ -128,11 +128,11 @@ render() { Now you can easily apply custom CSS styles using the classNames! #### placeholder -Type: `String` -Required: `false` +Type: `String`, +Required: `false`, Default: `"Address"` -You can pass placeholder prop to customize input's placeholder text +You can pass `placeholder` prop to customize input's placeholder text ### `geocodeByAddress` API @@ -142,17 +142,19 @@ geocodeByAddress(address, callback) ``` #### address -Type: `String` +Type: `String`, Required: `true` String that gets passed to Google Maps Geocoder #### callback -Type: `function` +Type: `Function`, Required: `true` Two arguments will be passed to the callback. -First argument is an error object. + +First argument is an error object, set to `null` when there's no error. + Second argument is an object with `lat` and `lng` keys