Skip to content

Commit f7b0e83

Browse files
committed
šŸ“ Fix README formatting & add information about How it Works / Contributions etc
1 parent 0fbd15e commit f7b0e83

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

ā€ŽREADME.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,9 @@ This tool uses the [Serverless Framework](https://serverless.com/) for deploymen
88

99
## How it works
1010

11-
This will take
11+
This will take the current set of webhook IP ranges from [GitHub's API](https://api.github.com/meta), and maintain a new security group allowing these IP ranges on ports 80 and 443.
12+
13+
This can maintain a security group across multiple VPCs.
1214

1315
## Configuration, Installation & Deployment
1416

@@ -20,11 +22,10 @@ All variables live under the prefix of `/github_secgrp_updater/{STAGE}`. Replace
2022

2123
Relevant variables are shown in the table below.
2224

23-
|----------------------|----------|---------------------|-------------|
2425
| Variable | Required | Default Value | Description |
26+
|----------------------|----------|---------------------|-------------|
2527
| /vpc_ids | Yes | | A comma separated list of VPC IDs in which to maintain a security group. |
2628
| /secgrp_name | No | AllowGitHubWebhooks | Override the name of the maintained security group |
27-
|----------------------|----------|---------------------|-------------|
2829

2930

3031
Finally, deploy with the following
@@ -40,4 +41,11 @@ serverless deploy
4041
This supports the serverless framework's concept of stages. Deploy additional stages like so:
4142
```
4243
serverless deploy --stage prod
43-
```
44+
```
45+
46+
## Contributions & Changelog
47+
Please see the [GitHub Releases page](https://github.com/hreeder/lambda-github-secgroup-updater/releases) for the changelog of this tool.
48+
49+
Releases will be properly versioned following [Semantic Versioning](https://semver.org/).
50+
51+
Contributions are welcome, in the form of either issues or pull requests.

0 commit comments

Comments
Ā (0)