TODO

[moimikey]

goals

1. this project is meant to be an isolated node module that is only meant to do one thing and do it well: parse ISO 3166-1 alpha 2 (US) or alpha 3 (USA) country codes.
2. in order to allow Browserify and/or Webpack, or any client side module loader for that matter, there will be no filesystem calls to necessitate virtual fs or transforms.
3. it's meant to have a very tiny footprint, thus, only one small goal. country code data can get quite big, the data sets will be compressed rather than raw.
4. the module should be able to easily integrate with something, for example, that detects the end-users locale (API is subject to change):

var locale = require('locale2');
var iso31661 = require('iso3166-1');
var alpha2 = iso31661.lookup(locale).alpha3;
var alpha3 = iso31661.lookup(locale).alpha2;

1. a lot of country code libraries do some things well and some things bad. i've encountered outdated or incomplete databases. It generally becomes the project owners discretion to update it. this module will be accompanied by a global binary that will fetch and cache to ensure that the databases are always up to date and complete. in the event something is outdated or incomplete, tests will fail and the binary will issue a warning. this will allow for immediate information as to whether or not the module will be adequate at that period in time and can be addressed in a timely fashion.

progress

• [ ]