Updated Readme & Docs

DenisCarriere · Feb 27, 2015 · 7f7af2c · 7f7af2c
1 parent 0a833c7
commit 7f7af2c
Show file tree

Hide file tree

Showing 2 changed files with 167 additions and 63 deletions.
diff --git a/README.md b/README.md
@@ -1,12 +1,14 @@
-# Geocoder [![badge][badge]][badge_url] [![travis][travis]][travis_url]
+# Geocoder
 
-Geocoder is a MIT Licensed Geocoding library, written in Python, 
+[![badge][badge]][badge_url] [![travis][travis]][travis_url]
+
+Geocoder is a MIT Licensed Geocoding library, written in Python,
 simple and consistent.
 
 ![providers][providers]
 
 Many online providers such as Google & Bing have geocoding services,
-these providers do not include Python libraries and have different 
+these providers do not include Python libraries and have different
 JSON responses between each other.
 
 Consistant JSON responses from various providers.
@@ -57,58 +59,65 @@ $ pip install geocoder
 
 ## Documentation
 
-Documentation is available at http://geocoder.readthedocs.org
+Documentation is available at http://deniscarriere.github.io/geocoder
 
 ## Twitter
 
-Speak up on Twitter @[DenisCarriere] and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [python].
+Speak up on Twitter [DenisCarriere] and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [python].
 
 ## Topic not available?
 
-If you cannot find a topic you are looking for, please feel free to ask me @[DenisCarriere] or post them on the [Github Issues Page].
+If you cannot find a topic you are looking for, please feel free to ask me [DenisCarriere] or post them on the [Github Issues Page].
 
 ## Feedback
 
 Please feel free to give any feedback on this module. If you find any bugs or any enhancements to recommend please send some of your comments/suggestions to the [Github Issues Page].
 
 ## Thanks to
 
-A big thanks to all the people that help contribute: 
+A big thanks to all the people that help contribute:
 
-* @[alexanderlukanin13]
-* @[themiurgo]
-* @[flebel]
-* @[patrickyan]
-* @[esy]
+* [Mahdi Yusuf]: Promoted by [Pycoders Weekly]
+* [Alex Pilon]: Corrected Pep 8 issues
+* [Philip Hubertus]: Provided HERE improvements & documentation
+* [Antonio Lima]: Improved code quality and introduced Rate Limits
+* [Alexander Lukanin]: Improved Python 3 compatibilty
+* [flebel]
+* [patrickyan]
+* [esy]
 
 
-[alexanderlukanin13]: https://github.com/alexanderlukanin13
-[themiurgo]: https://github.com/themiurgo
+[Alex Pilon]: http://alexpilon.ca
+[Mahdi Yusuf]: https://twitter.com/myusuf3
+[Pycoders Weekly]: https://twitter.com/pycoders
+[Philip Hubertus]: https://twitter.com/philiphubs
+[Antonio Lima]: https://twitter.com/themiurgo
+[Alexander Lukanin]: https://github.com/alexanderlukanin13
 [flebel]: https://github.com/flebel
 [patrickyan]: https://github.com/patrickyan
 [esy]: https://github.com/lambda-conspiracy
 
-[ArcGIS]: https://github.com/DenisCarriere/geocoder/wiki/ArcGIS
-[Bing]: https://github.com/DenisCarriere/geocoder/wiki/Bing
-[CanadaPost]: https://github.com/DenisCarriere/geocoder/wiki/CanadaPost
-[FreeGeoIP]: https://github.com/DenisCarriere/geocoder/wiki/FreeGeoIP
-[Geocoder-ca]: https://github.com/DenisCarriere/geocoder/wiki/Geocoder-ca
-[Geonames]: https://github.com/DenisCarriere/geocoder/wiki/Geonames 
-[Google]: https://github.com/DenisCarriere/geocoder/wiki/Google
-[HERE]: https://github.com/DenisCarriere/geocoder/wiki/HERE
-[MapQuest]: https://github.com/DenisCarriere/geocoder/wiki/MapQuest
-[MaxMind]: https://github.com/DenisCarriere/geocoder/wiki/MaxMind
-[OpenCage]: https://github.com/DenisCarriere/geocoder/wiki/OpenCage
-[OpenStreetMap]: https://github.com/DenisCarriere/geocoder/wiki/OpenStreetMap
-[GeoOttawa]: https://github.com/DenisCarriere/geocoder/wiki/GeoOttawa
-[TomTom]: https://github.com/DenisCarriere/geocoder/wiki/TomTom
-[Yahoo]: https://github.com/DenisCarriere/geocoder/wiki/Yahoo
-
-[GeoJSON Support]: https://github.com/DenisCarriere/geocoder/wiki/GeoJSON-Support
-[OpenStreetMap Support]: https://github.com/DenisCarriere/geocoder/wiki/OpenStreetMap-Support
-[Command Line Interface]: https://github.com/DenisCarriere/geocoder/wiki/Command-Line-Interface
-[Confidence Score]: https://github.com/DenisCarriere/geocoder/wiki/Confidence-Score
-[Well Known Text Support]: https://github.com/DenisCarriere/geocoder/wiki/Well-Known-Text-Support
+[ArcGIS]: http://geocoder.readthedocs.org/providers/ArcGIS
+[Bing]: http://geocoder.readthedocs.org/providers/Bing
+[CanadaPost]: http://geocoder.readthedocs.org/providers/CanadaPost
+[FreeGeoIP]: http://geocoder.readthedocs.org/providers/FreeGeoIP
+[Geocoder-ca]: http://geocoder.readthedocs.org/providers/Geocoder-ca
+[Geonames]: http://geocoder.readthedocs.org/providers/Geonames
+[Google]: http://geocoder.readthedocs.org/providers/Google
+[HERE]: http://geocoder.readthedocs.org/providers/HERE
+[MapQuest]: http://geocoder.readthedocs.org/providers/MapQuest
+[MaxMind]: http://geocoder.readthedocs.org/providers/MaxMind
+[OpenCage]: http://geocoder.readthedocs.org/providers/OpenCage
+[OpenStreetMap]: http://geocoder.readthedocs.org/providers/OpenStreetMap
+[GeoOttawa]: http://geocoder.readthedocs.org/providers/GeoOttawa
+[TomTom]: http://geocoder.readthedocs.org/providers/TomTom
+[Yahoo]: http://geocoder.readthedocs.org/providers/Yahoo
+
+[GeoJSON Support]: http://geocoder.readthedocs.org/features/GeoJSON
+[OpenStreetMap Support]: http://geocoder.readthedocs.org/features/OpenStreetMap
+[Command Line Interface]: http://geocoder.readthedocs.org/features/Command-Line-Interface
+[Confidence Score]: http://geocoder.readthedocs.org/features/Confidence-Score
+[Well Known Text Support]: http://geocoder.readthedocs.org/features/Well-Known-Text-Support
 
 [providers]: http://i.imgur.com/vUJKCGl.png
 [badge_url]: http://badge.fury.io/py/geocoder

diff --git a/docs/index.md b/docs/index.md
@@ -5,12 +5,12 @@ Date:    February 20, 2015
 base_url: http://geocoder.readthedocs.org
 
 
-# Geocoder [![badge][badge]][badge_url] [![travis][travis]][travis_url]
+# Geocoder
 
-Geocoder is a MIT Licensed Geocoding library, written in Python,
-simple and consistant.
+[![badge][badge]][badge_url] [![travis][travis]][travis_url]
 
-"Hello World"
+Geocoder is a MIT Licensed Geocoding library, written in Python,
+simple and consistent.
 
 ![providers][providers]
 
@@ -52,7 +52,7 @@ $ pip install geocoder
 - [Bing]
 - [CanadaPost]
 - [FreeGeoIP]
-- [Geocoder.ca]
+- [Geocoder-ca]
 - [Geonames]
 - [Google]
 - [HERE]
@@ -70,7 +70,7 @@ Documentation is available at http://deniscarriere.github.io/geocoder
 
 ## Twitter
 
-Speak up on Twitter [DenisCarriere] and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [#python].
+Speak up on Twitter [DenisCarriere] and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [python].
 
 ## Topic not available?
 
@@ -93,40 +93,135 @@ A big thanks to all the people that help contribute:
 
 
 
+[Philip Hubertus]: https://twitter.com/philiphubs
+[Antonio Lima]: https://twitter.com/themiurgo
+[Alexander Lukanin]: https://github.com/alexanderlukanin13
+[flebel]: https://github.com/flebe# Geocoder
+
+[![badge][badge]][badge_url] [![travis][travis]][travis_url]
+
+Geocoder is a MIT Licensed Geocoding library, written in Python,
+simple and consistent.
+
+![providers][providers]
+
+Many online providers such as Google & Bing have geocoding services,
+these providers do not include Python libraries and have different
+JSON responses between each other.
+
+Consistant JSON responses from various providers.
+
+```python
+>>> g = geocoder.google('New York City')
+>>> g.latlng
+[40.7127837, -74.0059413]
+>>> g.state
+'New York'
+>>> g.json
+...
+```
+
+## Features
+
+- [GeoJSON Support]
+- [OpenStreetMap Support]
+- [Command Line Interface]
+- [Confidence Score]
+- [Well Known Text Support]
+
+## Installation
+
+To install Geocoder, simply:
+
+```bash
+$ pip install geocoder
+```
+
+## Providers
+
+- [ArcGIS]
+- [Bing]
+- [CanadaPost]
+- [FreeGeoIP]
+- [Geocoder-ca]
+- [Geonames]
+- [Google]
+- [HERE]
+- [MapQuest]
+- [MaxMind]
+- [OpenCage]
+- [OpenStreetMap]
+- [GeoOttawa]
+- [TomTom]
+- [Yahoo]
+
+## Documentation
+
+Documentation is available at http://deniscarriere.github.io/geocoder
+
+## Twitter
+
+Speak up on Twitter [DenisCarriere] and tell me how you use this Python Geocoder. New updates will be pushed to Twitter Hashtags [python].
+
+## Topic not available?
+
+If you cannot find a topic you are looking for, please feel free to ask me [DenisCarriere] or post them on the [Github Issues Page].
+
+## Feedback
+
+Please feel free to give any feedback on this module. If you find any bugs or any enhancements to recommend please send some of your comments/suggestions to the [Github Issues Page].
+
+## Thanks to
+
+A big thanks to all the people that help contribute:
+
+* [Mahdi Yusuf]: Promoted by [Pycoders Weekly]
+* [Alex Pilon]: Corrected Pep 8 issues
+* [Philip Hubertus]: Provided HERE improvements & documentation
+* [Antonio Lima]: Improved code quality and introduced Rate Limits
+* [Alexander Lukanin]: Improved Python 3 compatibilty
+* [flebel]
+* [patrickyan]
+* [esy]
+
+
+[Alex Pilon]: http://alexpilon.ca
+[Mahdi Yusuf]: https://twitter.com/myusuf3
+[Pycoders Weekly]: https://twitter.com/pycoders
 [Philip Hubertus]: https://twitter.com/philiphubs
 [Antonio Lima]: https://twitter.com/themiurgo
 [Alexander Lukanin]: https://github.com/alexanderlukanin13
 [flebel]: https://github.com/flebel
 [patrickyan]: https://github.com/patrickyan
 [esy]: https://github.com/lambda-conspiracy
 
-[ArcGIS]: providers/ArcGIS
-[Bing]: providers/Bing
-[CanadaPost]: providers/CanadaPost
-[FreeGeoIP]: providers/FreeGeoIP
-[Geocoder.ca]: providers/Geocoder-ca
-[Geonames]: providers/Geonames
-[Google]: providers/Google
-[HERE]: providers/HERE
-[MapQuest]: providers/MapQuest
-[MaxMind]: providers/MaxMind
-[OpenCage]: providers/OpenCage
-[OpenStreetMap]: providers/OpenStreetMap
-[GeoOttawa]: providers/GeoOttawa
-[TomTom]: providers/TomTom
-[Yahoo]: providers/Yahoo
-
-[GeoJSON Support]: features/GeoJSON
-[OpenStreetMap Support]: features/OpenStreetMap
-[Command Line Interface]: features/Command-Line-Interface
-[Confidence Score]: features/Confidence-Score
-[Well Known Text Support]: features/Well-Known-Text-Support
+[ArcGIS]: http://geocoder.readthedocs.org/providers/ArcGIS
+[Bing]: http://geocoder.readthedocs.org/providers/Bing
+[CanadaPost]: http://geocoder.readthedocs.org/providers/CanadaPost
+[FreeGeoIP]: http://geocoder.readthedocs.org/providers/FreeGeoIP
+[Geocoder-ca]: http://geocoder.readthedocs.org/providers/Geocoder-ca
+[Geonames]: http://geocoder.readthedocs.org/providers/Geonames
+[Google]: http://geocoder.readthedocs.org/providers/Google
+[HERE]: http://geocoder.readthedocs.org/providers/HERE
+[MapQuest]: http://geocoder.readthedocs.org/providers/MapQuest
+[MaxMind]: http://geocoder.readthedocs.org/providers/MaxMind
+[OpenCage]: http://geocoder.readthedocs.org/providers/OpenCage
+[OpenStreetMap]: http://geocoder.readthedocs.org/providers/OpenStreetMap
+[GeoOttawa]: http://geocoder.readthedocs.org/providers/GeoOttawa
+[TomTom]: http://geocoder.readthedocs.org/providers/TomTom
+[Yahoo]: http://geocoder.readthedocs.org/providers/Yahoo
+
+[GeoJSON Support]: http://geocoder.readthedocs.org/features/GeoJSON
+[OpenStreetMap Support]: http://geocoder.readthedocs.org/features/OpenStreetMap
+[Command Line Interface]: http://geocoder.readthedocs.org/features/Command-Line-Interface
+[Confidence Score]: http://geocoder.readthedocs.org/features/Confidence-Score
+[Well Known Text Support]: http://geocoder.readthedocs.org/features/Well-Known-Text-Support
 
 [providers]: http://i.imgur.com/vUJKCGl.png
 [badge_url]: http://badge.fury.io/py/geocoder
 [travis_url]: https://travis-ci.org/DenisCarriere/geocoder
 [badge]: https://badge.fury.io/py/geocoder.png
 [travis]: https://travis-ci.org/DenisCarriere/geocoder.png?branch=master
 [DenisCarriere]: https://twitter.com/DenisCarriere
-[#python]: https://twitter.com/search?q=%23python
+[python]: https://twitter.com/search?q=%23python
 [Github Issues Page]: https://github.com/DenisCarriere/geocoder/issues