readme.md in aws_recon-0.5.2 vs readme.md in aws_recon-0.5.3
- old
+ new
@@ -1,8 +1,8 @@
[![GitHub Workflow Status (branch)](https://img.shields.io/github/workflow/status/darkbitio/aws-recon/smoke-test/main)](https://github.com/darkbitio/aws-recon/actions?query=branch%3Amain)
[![Gem Version](https://badge.fury.io/rb/aws_recon.svg)](https://rubygems.org/gems/aws_recon)
-
+[![AWS Service Regions](https://github.com/darkbitio/aws-recon/actions/workflows/check-aws-regions.yml/badge.svg?branch=main&event=schedule)](https://github.com/darkbitio/aws-recon/actions/workflows/check-aws-regions.yml)
# AWS Recon
A multi-threaded AWS security-focused inventory collection tool written in Ruby.
This tool was created to facilitate efficient collection of a large amount of AWS resource attributes and metadata. It aims to collect nearly everything that is relevant to the security configuration and posture of an AWS environment.
@@ -52,17 +52,17 @@
To run locally, first install the gem:
```
$ gem install aws_recon
-Fetching aws_recon-0.4.5.gem
+Fetching aws_recon-0.5.2.gem
Fetching aws-sdk-3.0.1.gem
Fetching parallel-1.20.1.gem
...
Successfully installed aws-sdk-3.0.1
Successfully installed parallel-1.20.1
-Successfully installed aws_recon-0.4.5
+Successfully installed aws_recon-0.5.2
```
Or add it to your Gemfile using `bundle`:
```
@@ -70,11 +70,11 @@
Fetching gem metadata from https://rubygems.org/
Resolving dependencies...
...
Using aws-sdk 3.0.1
Using parallel-1.20.1
-Using aws_recon 0.4.5
+Using aws_recon 0.5.2
```
## Usage
AWS Recon will leverage any AWS credentials (see [requirements](#requirements)) currently available to the environment it runs in. If you are collecting from multiple accounts, you may want to leverage something like [aws-vault](https://github.com/99designs/aws-vault) to manage different credentials.
@@ -247,10 +247,10 @@
Most users will want to limit collection to relevant services and regions. Running without any exclusions will attempt to collect all resources from all regions enabled for the account.
```
$ aws_recon -h
-AWS Recon - AWS Inventory Collector (0.4.5)
+AWS Recon - AWS Inventory Collector (0.5.2)
Usage: aws_recon [options]
-r, --regions [REGIONS] Regions to scan, separated by comma (default: all)
-n, --not-regions [REGIONS] Regions to skip, separated by comma (default: none)
-s, --services [SERVICES] Services to scan, separated by comma (default: all)