state-codes-0.1.1: README.md

# state-codes

[![Build Status](https://travis-ci.org/acamino/state-codes.svg?branch=master)](https://travis-ci.org/acamino/state-codes)

This package provides the ISO 3166-2:US state codes and i18n names.
This work is entirely based on the package [Data.CountryCodes](http://hackage.haskell.org/package/country-codes).

## Local Development

1. Fork the project [on GitHub](https://github.com/acamino/state-codes) and clone your fork locally.

   ```bash
   $ git clone git@github.com:acamino/state-codes.git
   $ cd state-codes
   $ git remote add upstream https://github.com/acamino/state-codes.git
   ```

1. Install [Stack](https://docs.haskellstack.org/en/stable/README/).

1. Get the appropriate GHC for the project.

   ```bash
   $ stack setup
   ```

1. If you want to launch a REPL and have fun with this program.

   ```bash
   $ stack repl
   ```

## Issues & Support

Please [file tickets](https://github.com/acamino/state-codes/issues) for
bug or problems.

## Contributing

Edits and enhancements are welcome. Just fork the repository, make your changes
and send me a pull request.

## Licence

The code in this repository is licensed under the terms of the
[MIT License](http://www.opensource.org/licenses/mit-license.html).  
Please see the [LICENSE](LICENSE) file for details.