Skip to content

Commit 3e8eaf9

Browse files
authored
Update README.md
1 parent 5b71fb8 commit 3e8eaf9

File tree

1 file changed

+12
-84
lines changed

1 file changed

+12
-84
lines changed

README.md

Lines changed: 12 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@
1111
<p align="center">
1212
<a href="https://github.com/not-existing-organization/terraform_module_security_group_checker">
1313
<img src="https://github.com/not-existing-organization/terraform_module_security_group_checker/raw/master/.assets/terraform-logo.png" alt="Terraform Logo" width="80" height="80">
14-
1514
</a>
1615

1716
<h3 align="center">terraform_module_security_group_checker</h3>
@@ -22,8 +21,6 @@
2221
<a href="https://github.com/not-existing-organization/terraform_module_security_group_checker/blob/master/README.md"><strong>Explore the docs »</strong></a>
2322
<br />
2423
<br />
25-
<a href="https://github.com/not-existing-organization/terraform_module_security_group_checker">View Demo</a>
26-
·
2724
<a href="https://github.com/not-existing-organization/terraform_module_security_group_checker/issues/new?labels=i%3A+bug&template=1-bug-report.md">Report Bug</a>
2825
·
2926
<a href="https://github.com/not-existing-organization/terraform_module_security_group_checker/issues/new?labels=i%3A+enhancement&template=2-feature-request.md">Request Feature</a>
@@ -55,35 +52,13 @@ This is a simple project that involves a python script that scans the Ec2 API in
5552

5653
I made this project as part of my learning process since i did not have that much practice with the DynamoDB service, but also i wanted to glue everything with python and terraform and have some fun along the way.
5754

58-
<!--
59-
There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.
60-
61-
Here's why:
62-
63-
- Your time should be focused on creating something amazing. A project that solves a problem and helps others
64-
- You shouldn't be doing the same tasks over and over like creating a README from scratch
65-
- You should element DRY principles to the rest of your life :smile:
66-
67-
Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue.
68-
69-
A list of commonly used resources that I find helpful are listed in the acknowledgements.
70-
-->
7155

7256
### Built With
7357

74-
Terraform
75-
76-
Python
77-
78-
AWS services (DynamoDB, IAM, Lambda, Cloudwatch)
58+
- Terraform
59+
- Python
60+
- AWS services (DynamoDB, IAM, Lambda, Cloudwatch)
7961

80-
<!--
81-
This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.
82-
83-
- [Bootstrap](https://getbootstrap.com)
84-
- [JQuery](https://jquery.com)
85-
- [Laravel](https://laravel.com)
86-
-->
8762

8863
---
8964

@@ -92,61 +67,20 @@ This section should list any major frameworks that you built your project using.
9267
## Getting Started
9368

9469

95-
<!--
96-
This is an example of how you may give instructions on setting up your project locally.
97-
To get a local copy up and running follow these simple example steps.
98-
-->
99-
10070
### Prerequisites
10171

102-
Terraform: Deployed with version 1.0.6
103-
104-
Python: AWS lambda runtime with version 3.8
105-
106-
<!--
72+
- Terraform: Deployed with version 1.0.6
73+
- Python: AWS lambda runtime with version 3.8
10774

108-
This is an example of how to list things you need to use the software and how to install them.
109-
110-
- npm
111-
112-
```sh
113-
npm install npm@latest -g
114-
```
115-
-->
11675

11776
### Installation
11877

119-
Install Terraform
120-
121-
https://learn.hashicorp.com/tutorials/terraform/install-cli
122-
123-
Install AWS cli and configure your AWS credentials (you should have a AWS account already)
124-
125-
https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
126-
https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html
127-
128-
129-
130-
<!--
131-
1. Get a free API Key at [https://example.com](https://example.com)
132-
2. Clone the repo
133-
134-
```sh
135-
git clone https://github.com/your_username_/Project-Name.git
136-
```
137-
138-
3. Install NPM packages
139-
140-
```sh
141-
npm install
142-
```
143-
144-
4. Enter your API in `config.js`
145-
146-
```JS
147-
const API_KEY = 'ENTER YOUR API';
148-
```
149-
-->
78+
- Install Terraform
79+
> https://learn.hashicorp.com/tutorials/terraform/install-cli
80+
- Install AWS cli and configure your AWS credentials (you should have a AWS account already)
81+
> https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
82+
>
83+
> https://docs.aws.amazon.com/cli/latest/userguide/getting-started-quickstart.html
15084
15185
---
15286

@@ -156,20 +90,14 @@ const API_KEY = 'ENTER YOUR API';
15690

15791
The whole solution will be deployed via terraform
15892

159-
```
93+
```bash
16094
terraform init
16195
terraform plan
16296
terraform apply
16397
```
16498

16599
There's a locals block in the *main.tf* file to modify a couple of fields that are consumed by several parts of the project. The *table name*, *attribue name* for that table and *schedule expression* that defines the rate of how frequent the Cloudwatch event rule executes the lambda function.
166100

167-
<!--
168-
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
169-
170-
_For more examples, please refer to the [Documentation](https://example.com)_
171-
-->
172-
173101
---
174102

175103
<!-- ROADMAP -->

0 commit comments

Comments
 (0)