Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
L0wry authored Sep 11, 2018
1 parent af5661c commit 834994f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

### Brought to you by The Times Tooling team  🛠

## Overview
### Overview

DeCidr is a Node.js application that generates a non-clashing CIDR block to be used with a peering connection.

## Use case
### Use case

Let's say you have a VPC called 'Backend' and you would like to peer many 'Front End' VPCs to it. To do this you can use 'Peering Connections' from AWS, which require non-clashing CIDR blocks. For each peering connection you will need to ensure the CIDR block does not clash with the backend CIDR block, or any of the other peerings.

Before creating your new VPC, DeCidr will read your 'Backend' VPC's Route Table(s) to determine what CIDR ranges are taken. It will then provide you with a valid, non-clashing CIDR range, to use on your new front end VPC.

## Installation
### Installation

Run `yarn global add decidr` to install the application globally.

## Use
### Use

To use the tool you will need to provide all of the below required values. When specifying the tag value, you can use wild cards to match multiple route tables. This will ensure that the CIDR range does not clash with any of the matching route tables.

Expand All @@ -32,26 +32,26 @@ Output:

`10.180.0.0/24`

### Extra
#### Extra

`-v --version` - Prints the version of DeCidr

`-h --help` - Provides tool help information

### Exit Codes
#### Exit Codes
Exit Code 1: Not all arguments have been provided

Exit Code 2: No availability in the range provided

## Development
### Development

`yarn` to get the dependencies

`yarn build` to build the project (must be done when making changes)

`npm link` to create the symbolic link for running the binary from your terminal e.g. `DeCidr -v`

### Test
#### Test

`yarn test` to run all tests with coverage

Expand Down

0 comments on commit 834994f

Please sign in to comment.