Skip to content

Commit 2dbc488

Browse files
authored
Readme updates.
1 parent 989fd8a commit 2dbc488

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,13 @@
88
This script deploys applications with the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) service. This script has been adapted to be easily portable and configurable via environment variables such that it can be incorporated within CI services that do not natively include support for Code Deploy. Additionally, this script includes additional functionality described below that is typically not included in out-of-box Code Deploy CI systems. For more information, refer to the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation or
99
the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html).
1010

11-
#### Features:
11+
### Features:
12+
* Minimal dependencies: aws (If not installed automatically installed)
1213
* Compression of source contents
1314
* Ability to limit the number of stored revisions by a key prefix to help reduce S3 total file size
1415
* Server side encryption for revisions
1516
* Full diagnostic output from failed instances
1617

17-
#### Operating Systems Supported:
18-
* Debian 7
19-
* Ubuntu 12.04
20-
* Ubuntu 14.04
21-
2218

2319
## Sample Output
2420

@@ -84,16 +80,18 @@ Status | In Progress: 0 | Pending: 0 | Skipped: 0 | Succeeded: 1 | Failed:
8480

8581
## How to Include In Your Project
8682

87-
1. Via Composer (For PHP Projects)
88-
* Include in `composer.json` as follows:
83+
### Composer (For PHP Projects)
84+
1. Include in `composer.json` as follows:
8985

90-
```json
91-
"require-dev" : {
92-
"techpivot/aws-code-deploy": "~1.0"
93-
}
94-
```
86+
```json
87+
"require-dev" : {
88+
"techpivot/aws-code-deploy": "~1.0"
89+
}
90+
```
9591
* The file can then be executed from the /vendor/bin directory: `bash vendor/bin/aws-code-deploy.sh`
9692

93+
### NPM (General Projects)
94+
9795

9896
## Environment Variables
9997

0 commit comments

Comments
 (0)