Skip to content

Commit 305df1f

Browse files
committed
Merge pull request #4 from Ziptastic/update-readme
Update README.md
2 parents a24542e + fae9c38 commit 305df1f

1 file changed

Lines changed: 25 additions & 5 deletions

File tree

README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,29 @@ Official python library for GetZiptastic.com
99
pip install ziptastic-python (coming soon)
1010

1111

12+
## Testing
13+
`$ nosetests`
14+
15+
With coverage
16+
17+
`$ nosetests --with-coverage --cover-package=ziptastic`
18+
19+
1220
## Usage
13-
from ziptastic import Ziptastic
14-
15-
# Set your API key. (Available at https://www.getziptastic.com/dashboard)
16-
api = Ziptastic('<your api key>')
17-
result = api.get_from_postal_code('48867')
21+
### Forward geocoding
22+
```python
23+
from ziptastic import Ziptastic
24+
25+
# Set your API key. (Available at https://www.getziptastic.com/dashboard)
26+
api = Ziptastic('<your api key>')
27+
result = api.get_from_postal_code('48867')
28+
```
29+
30+
### Reverse geocoding
31+
```python
32+
from ziptastic import Ziptastic
33+
34+
# Set API key.
35+
api = Ziptastic('<your api key>')
36+
result = api.get_from_coordinates('42.9934', '-84.1595')
37+
```

0 commit comments

Comments
 (0)