From 0ab4e43eabd89f6a789d6f168f680bffe17c6e99 Mon Sep 17 00:00:00 2001 From: Ben Burwell Date: Wed, 18 Nov 2015 15:09:33 -0500 Subject: Initial commit --- README.markdown | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.markdown (limited to 'README.markdown') diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..3007686 --- /dev/null +++ b/README.markdown @@ -0,0 +1,23 @@ +# zipserver + +A simple json api that returns location info about zipcodes. + +## Usage + +To run the server on port 8080: + +```sh +go build . +./zipserver +``` + +To get zipcode info using `curl` and [`jq`](https://stedolan.github.io/jq/): + +```sh +curl --silent http://localhost:8080/zip/18101 | jq '.' +``` + +## Data + +This project uses public-domain zipcode data from the [Zip Code Database Project](http://zips.sourceforge.net). + -- cgit v1.2.3