summaryrefslogtreecommitdiff
path: root/README.markdown
blob: 3007686b23a6d280b81184d0726e71135feef352 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
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).