🇨🇭 Find Swiss Canton by abbreviation or name
Switch branches/tags
Clone or download
stefanzweifel Merge pull request #73 from stefanzweifel/dependabot/npm_and_yarn/str…
…ingstream-0.0.6

[Security] Bump stringstream from 0.0.5 to 0.0.6
Latest commit 0bb9172 Nov 1, 2018

README.md

🇨🇭 js-swiss-cantons

Build Status

Find Swiss canton by it's abbreviation or name. (This is a port of php-swiss-cantons)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

In order to work on this package you should have npm, yarn and ava installed globally.

git clone https://github.com/stefanzweifel/js-swiss-cantons.git

Installing

You should install the package with yarn or npm in your project.

npm install @stefanzweifel/js-swiss-cantons

Usage

Currently there two methods available on the CantonManager Class: getByAbbreviation and getByName.

import CantonManager from '@stefanzweifel/js-swiss-cantons';

let manager = new CantonManager;
let canton = manager.getByAbbreviation('SH');
let canton = manager.getByName('Schaffhausen');

console.log(
    canton.setLanguage('de').getName(), // Schaffhausen
);

End with an example of getting some data out of the system or using it for a little demo

Running the tests

Tests are written with ava.

npm run test

Deployment

npm update patch | minor | major
npm publish

Built With

  • ava - Test Framework
  • nyc - Code Coverage

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

Acknowledgments