Skip to content

Commit

Permalink
Prettier: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Hallberg committed Mar 15, 2018
1 parent f43ccfa commit 5c40271
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# zips [![Travis status](https://travis-ci.org/crhallberg/zips.svg?branch=master)](https://travis-ci.org/crhallberg/zips)

Light, fast, tree-based way to get cities by zipcode and location.

```bash
npm install zips
```

```javascript
const zips = require('zips');
const zips = require("zips");
```

U.S. postal codes only. For now.
Expand All @@ -26,8 +27,9 @@ Returns the closest place object to the specified coordinates.
### Why?

I saw a lot of zip database modules on npm, but I was displeased with three aspects
- Old data (zips uses 2010 US Census data from [geonames.org](http://www.geonames.org/), the most up-to-date I could find).
- Huge, raw data (zips' data is pre-processed so it can just load and go).
- List searching (zips organizes its data into trees instead of going down a list until a match is found or a large hash table).

* Old data (zips uses 2010 US Census data from [geonames.org](http://www.geonames.org/), the most up-to-date I could find).
* Huge, raw data (zips' data is pre-processed so it can just load and go).
* List searching (zips organizes its data into trees instead of going down a list until a match is found or a large hash table).

I hope you're happy too.

0 comments on commit 5c40271

Please sign in to comment.