Skip to content

Commit

Permalink
Updated Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DenisCarriere committed Feb 20, 2015
1 parent dcc5415 commit 2137f40
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 7 deletions.
9 changes: 8 additions & 1 deletion docs/Quickstart.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
Title: Quickstart - Python Geocoder API
Summary: Home page for Geocoder
Authors: Denis Carriere
Date: February 20, 2015
base_url: http://geocoder.readthedocs.org


# Quickstart

## Installation
Expand All @@ -8,7 +15,7 @@ Installing with ``PIP``

```bash
$ pip install geocoder
```
```

Installing with ``Easy Install`` **Not recommended**

Expand Down
17 changes: 13 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,21 @@
Title: Python Geocoder API
Summary: Home page for Geocoder
Authors: Denis Carriere
Date: February 20, 2015
base_url: http://geocoder.readthedocs.org


# Geocoder [![badge][badge]][badge_url] [![travis][travis]][travis_url]

Geocoder is a MIT Licensed Geocoding library, written in Python,
Geocoder is a MIT Licensed Geocoding library, written in Python,
simple and consistant.

"Hello World"

![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.
Expand Down Expand Up @@ -73,7 +82,7 @@ Please feel free to give any feedback on this module. If you find any bugs or an

## Thanks to

A big thanks to all the people that help contribute:
A big thanks to all the people that help contribute:

* [Philip Hubertus]: Provided HERE improvements & documentation
* [Antonio Lima]: Improved code quality and introduced Rate Limits
Expand All @@ -96,7 +105,7 @@ A big thanks to all the people that help contribute:
[CanadaPost]: providers/CanadaPost
[FreeGeoIP]: providers/FreeGeoIP
[Geocoder.ca]: providers/Geocoder-ca
[Geonames]: providers/Geonames
[Geonames]: providers/Geonames
[Google]: providers/Google
[HERE]: providers/HERE
[MapQuest]: providers/MapQuest
Expand Down
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
site_name: geocoder
site_name: Python Geocoder API
theme: readthedocs
Authors: Denis Carriere
Date: February 20, 2015
repo_url: https://github.com/DenisCarriere/geocoder
markdown_extensions: ['tables']
base_url: http://geocoder.readthedocs.org
markdown_extensions: ['tables', 'toc', 'meta', 'fenced_code']

pages:
# Home Page
# =========
Expand Down

0 comments on commit 2137f40

Please sign in to comment.