Skip to content

Commit

Permalink
💯 change to using calendar versions
Browse files Browse the repository at this point in the history
  • Loading branch information
blakek committed Nov 8, 2021
1 parent 9dd11c6 commit 024990f
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,10 @@ yarn add us-zips
npm install us-zips
```

:information_source: **NOTE:** Due to ZIP codes always changing, this package
uses calendar versioning (aka [CalVer][5]). This means each year will have a
separate "major" version from npm and Yarn's perspective.

## Acknowledgments

Data for ZIP codes and their geolocations was generated from [this file][1],
Expand All @@ -127,3 +131,4 @@ MIT
[2]: https://github.com/blakek/geo2zip
[3]: https://github.com/blakek/standardize-geolocation
[4]: https://www.census.gov/geographies/reference-files/time-series/geo/gazetteer-files.html
[5]: https://calver.org/
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "us-zips",
"version": "5.1.0",
"version": "2021.11.0",
"description": "A list of US ZIP codes and their geolocations",
"main": "index.js",
"repository": {
Expand Down

0 comments on commit 024990f

Please sign in to comment.