Update docs and readme

milesgranger · Oct 7, 2018 · 17fcb85 · 17fcb85
1 parent 89104f6
commit 17fcb85
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ Python package to find the elevation / altitude at a given geo coordinate.
 
 ### Via CLI
 ```
-altitudo 39.90974 -106.17188
+altitudo -- 39.90974 -106.17188
 2624.0
 ```
 

diff --git a/altitudo/__init__.py b/altitudo/__init__.py
@@ -6,4 +6,4 @@
 __email__ = 'miles59923@gmail.com'
 __version__ = '0.1.0'
 
-from altitudo.altitudo import altitudo
+from .altitudo import altitudo
diff --git a/docs/usage.rst b/docs/usage.rst
@@ -4,4 +4,16 @@ Usage
 
 To use Altitudo in a project::
 
-    import altitudo
+    from altitudo import altitudo
+
+    # Return elevation in meters
+    elevation = altitudo(lat=39.90974, lon=-106.17188)
+
+    # ...or feet
+    elevation = altitudo(lat=39.90974, lon=-106.17188, feet=True)
+
+    # Pass a list of latitude and longitude coordinates
+    elevation = altitudo(lat=[39.90974, 40.93028], lon=[-106.17188, -105.1803099])
+
+Note a single coordinate submission results in a single value.
+Givening an iterable of coordinates returns a list of dicts.
-Original file line number
+Diff line change
@@ Expand Up @@
     ### Via CLI
     ```
-    altitudo 39.90974 -106.17188
+    altitudo -- 39.90974 -106.17188
 .0
     ```
@@ Expand Down @@