Skip to content

Commit

Permalink
Update README (#107)
Browse files Browse the repository at this point in the history
* Update description

Updated the main description and minor  corrections.

* Description update

Main description updated, and minor corrections.

Co-authored-by: Christian Martorella <laramies@gmail.com>
  • Loading branch information
oscarbc96 and laramies committed Mar 11, 2020
1 parent 3b194e2 commit 163f168
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@
[![Total alerts](https://img.shields.io/lgtm/alerts/g/Skyscanner/cfripper.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Skyscanner/cfripper/alerts/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/Skyscanner/cfripper.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Skyscanner/cfripper/context:python)

Library and CLI tool for analysing CloudFormation templates and check them for security compliance.
CFRipper is a Library and CLI security analyzer for AWS CloudFormation templates. You can use CFRipper to prevent deploying insecure AWS resources into your Cloud environment. You can write your own compliance checks by adding new custom plugins.

Docs available in https://cfripper.readthedocs.io/
Docs and more details available in https://cfripper.readthedocs.io/

## CLI Usage

Expand All @@ -26,7 +26,7 @@ Analysing /tmp/root_bypass.json...
Valid: True
```

### Using resolve flag
### Using the "resolve" flag
```bash
$ cfripper /tmp/root.yaml /tmp/root_bypass.json --format txt --resolve
Analysing /tmp/root.yaml...
Expand Down

0 comments on commit 163f168

Please sign in to comment.