twiho / postalcodes.net

Library for managing postal codes in .NET

PostalCodes.Net

Library for managing postal codes for .NET

Branching model

This package follows the git-flow branching model:

• Develop features of a feature/* branch.
• Create pull request to a master branch.
• Once master is branched into release/<major>.<minor>.<patch> an automatic job builds and if successful publishes the NuGet package.
• After successful build the artifact will be available via NuGet or directly from GitHub Releases.

Prerequisites

If you want to open the solution file in Visual Studio, you may need the Sandcastle Help File Builder Visual Studio extension available in the bundle here.

Building

The following snippets assume your working directory is in the root of the repository:

> git clone https://github.com/Cimpress-MCP/PostalCodes.Net.git
> cd PostalCodes.Net

On Windows

In order to build the project you can use plain msbuild:

> nuget restore
> msbuild

On Mac

> nuget restore
> xbuild

On Linux

Install the nuget and mono-xbuild packages from Mono Project package repository.

> nuget restore
> xbuild

##Reading the docs

On Windows

Microsoft Compiled HTML Help is supported by default on Windows.

On Mac

One alternative to read Microsoft Compiled HTML Help on a Mac is iChm or Chmox.

On Linux

A popular cross-platform alternative to read Microsoft Compiled HTML Help is xCHM.

##Usages

Creating postal code objects

var country = CountryFactory.Instance.CreateCountry("PL");
var postalCode = PostalCodeFactory.Instance.CreatePostalCode(
	country, "44-100");

in case of invalid postal code you will get an ArgumentException with the proper message explaining the reason for the failure.