Browse files

Fixed REAME.md

  • Loading branch information...
1 parent 9019495 commit ba9e01360c277ba1af687eafbefaa59bd56a0705 @alexksikes committed Apr 29, 2011
Showing with 8 additions and 8 deletions.
  1. +8 −8 README.md
View
16 README.md
@@ -1,20 +1,20 @@
sGeo
====
-1. About
---------
+About
+-----
sGeo is a very simple minimalistic geocoder built around [Geonames](http://www.geonames.org/), [zip-codes.com](http://www.zip-codes.com/) and [Sphinx](http://sphinxsearch.com/). You can try to geocode any place in the world or just restrict it to US cities and zip codes. sGeo will not geocode full addresses as they are not available in Geonames. It will only geocode cities, zip codes or places such as national parks, universities, etc ... sGeo was first written in late 2007 to batch geocode the contractor database used in [Chiefmall](http://www.chiefmall.com).
Feel free to try a [demo](http://sgeo.ksikes.org).
-2. Installation
----------------
+Installation
+-------------
Read [INSTALL.md](https://github.com/alexksikes/sGeo/blob/master/INSTALL.md) for installation instructions.
-3. How to use within your code
-------------------------------
+How to use within your code
+----------------------------
import sgeo
gc = sgeo.GeoCoder(usa_only=True)
@@ -35,8 +35,8 @@ Read [INSTALL.md](https://github.com/alexksikes/sGeo/blob/master/INSTALL.md) for
hits = gc.get_nearby_places(coords.lat, coords.lon, 'hotels', radius=50*1000, limit=10)
print hits
-4. Use command line interface for testing
------------------------------------------
+Use command line interface for testing
+---------------------------------------
python sgeo/sgeo/sg_cli.py --usa-only 'Newport Beach, CA'

0 comments on commit ba9e013

Please sign in to comment.