diff --git a/README.md b/README.md new file mode 100644 index 0000000..938beb3 --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# aws-ips +check network addresses for AWS Services + +[![Build Status](https://www.travis-ci.org/jonhadfield/aws-ips.svg?branch=master)](https://www.travis-ci.org/jonhadfield/aws-ips) [![Go Report Card](https://goreportcard.com/badge/github.com/jonhadfield/aws-ips)](https://goreportcard.com/report/github.com/jonhadfield/aws-ips) + +## about + +AWS publish a list of IP ranges that correspond to their services and regions. Linked to from [here](https://docs.aws.amazon.com/general/latest/gr/aws-ip-ranges.html). + +## features + +- list and filter prefixes (by region, service, cidr) +- reverse lookup of IP address or FQDN to AWS range +- output results as JSON, YAML, or Text + +## changelog +0.0.1 - initial + +## installation +Download the latest release here: https://github.com/jonhadfield/aws-ips/releases + +#### macOS and Linux + +Install: +`` +$ install /usr/local/bin/aws-ips +`` +#### Windows + +An installer is planned, but for now... +Download the binary 'aws-ips_windows_amd64.exe' and rename to aws-ips.exe + +### commands and options: +`` +$ aws-ips --help +`` + + +