@corvina/cidr/README.md

CIDR Operation helper

# Corvina CIDR #

This project contains some helper functions to work with CIDR blocks. It's written in typescript and can be imported added to your project using npm.

## Installation ##

Install the package using *npm*:

```bash
npm install @corvina/cidr
```

Install the package in the browser using *unpkg*:

```html
<script src="https://unpkg.com/@corvina/cidr"></script>
```

or using script of type module:

```html
<script type="module">
  import { cidr, endpoint } from 'https://unpkg.com/@corvina/cidr';
</script>
```

## Usage ##

Typescript sample:

```typescript
import { cidr, endpoint } from '@corvina/cidr';
```

See test files (.test.ts) for a complete list of functions and their usage.

## How to develop ##

- install dependencies with `npm install`
- write code in `src/`
- run tests with `npm test`
- update the version in `package.json`
- build and deploy the project on npmjs with `npm run deploy`