summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorBen Burwell <ben.burwell@trifecta.com>2015-11-18 15:11:54 -0500
committerBen Burwell <ben.burwell@trifecta.com>2015-11-18 15:11:54 -0500
commit08b44af47306d8ede59496ccb16c97b4028cd677 (patch)
tree486281fec8e327ffacadded1162468ebd54108f5 /README.markdown
parent0ab4e43eabd89f6a789d6f168f680bffe17c6e99 (diff)
Update readme
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown8
1 files changed, 2 insertions, 6 deletions
diff --git a/README.markdown b/README.markdown
index 3007686..c698dd5 100644
--- a/README.markdown
+++ b/README.markdown
@@ -1,8 +1,4 @@
-# zipserver
-
-A simple json api that returns location info about zipcodes.
-
-## Usage
+# Usage
To run the server on port 8080:
@@ -17,7 +13,7 @@ To get zipcode info using `curl` and [`jq`](https://stedolan.github.io/jq/):
curl --silent http://localhost:8080/zip/18101 | jq '.'
```
-## Data
+# Data
This project uses public-domain zipcode data from the [Zip Code Database Project](http://zips.sourceforge.net).