Update Docs

README.md

@@ -22,12 +22,6 @@ Consistant JSON responses from various providers.
 ...
 ```
 
-## Features
-
-- Formats (JSON, GeoJSON, OSM, WKT)
-- Command Line Interface
-- Confidence Score
-
 ## Installation
 
 To install Geocoder, simply:
@@ -51,6 +45,15 @@ $ pip install geocoder
 | ArcGIS        |               |             |
 
 
+## Features
+
+- Formats (JSON, GeoJSON, OSM, WKT)
+- Command Line Interface
+- Confidence Score
+
+## Documentation
+
+https://geocoder.readthedocs.org/
 
 ## Twitter
 

docs/examples/using iPython.md

@@ -0,0 +1,45 @@
+# Using iPython
+
+```bash
+$ pip install ipython
+$ ipython
+```
+
+Using the **TAB** key after entering '.' you will see all the available **providers**.
+
+```python
+>>> import geocoder
+>>> g = geocoder.
+geocoder.api             geocoder.geolytica       geocoder.mapquest
+geocoder.arcgis          geocoder.geonames        geocoder.nokia
+geocoder.base            geocoder.get             geocoder.osm
+geocoder.bing            geocoder.google          geocoder.timezone
+geocoder.canadapost      geocoder.ip              geocoder.yahoo
+geocoder.cli             geocoder.keys            geocoder.tomtom
+geocoder.elevation       geocoder.location 
+...       
+```
+
+Using the **TAB** key again, you can see all the available **attributes**.
+
+```python
+>>> g = geocoder.google('Ottawa')
+>>> g.
+g.accuracy            g.latlng              g.south
+g.address             g.lng                 g.southeast
+g.api                 g.locality            g.southwest
+g.attributes          g.location            g.state
+g.bbox                g.neighborhood        g.status
+g.content             g.north               g.status_code
+g.country             g.northeast           g.status_description
+g.county              g.northwest           g.street_number
+g.debug               g.ok                  g.sublocality
+g.east                g.params              g.subpremise
+g.error               g.parse               g.url
+g.geometry            g.postal              g.west
+g.headers             g.provider            g.wkt
+g.help                g.quality             g.x
+g.json                g.route               g.y
+g.lat                 g.short_name
+...    
+```

docs/examples/using proxies.md

@@ -0,0 +1,11 @@
+# Using Proxies
+
+Using proxies will hide the IP address of the client computer when calling a request using the Python Geocoder.
+
+```python
+>>> import geocoder
+>>> proxies = {'http':'http://108.165.33.12:3128'}
+>>> g = geocoder.google('New York City', proxies=proxies)
+>>> g.json
+...
+```

docs/index.md

@@ -28,12 +28,6 @@ Consistant JSON responses from various providers.
 ...
 ```
 
-## Features
-
-- Formats (JSON, GeoJSON, OSM, WKT)
-- Command Line Interface
-- Confidence Score
-
 ## Installation
 
 To install Geocoder, simply:
@@ -57,6 +51,15 @@ $ pip install geocoder
 | ArcGIS        |               |             |
 
 
+## Features
+
+- Formats (JSON, GeoJSON, OSM, WKT)
+- Command Line Interface
+- Confidence Score
+
+## Documentation
+
+https://geocoder.readthedocs.org/
 
 ## Twitter
 

mkdocs.yml

@@ -26,6 +26,8 @@ pages:
 # Examples
 # ========
 - ['examples/write to csv.md', 'Examples', 'Write to CSV']
+- ['examples/using iPython.md', 'Examples', 'Using iPython']
+- ['examples/using proxies.md', 'Examples', 'Using Proxies']
 
 # Providers
 # =========