Skip to content

Commit ba8c907

Browse files
committed
Improving documentation in Readme.
1 parent d681a28 commit ba8c907

File tree

1 file changed

+25
-16
lines changed

1 file changed

+25
-16
lines changed

README.md

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55
[![npm](https://img.shields.io/npm/dt/aws-code-deploy.svg?style=flat-square&label=npm%20downloads)](https://www.npmjs.com/package/aws-code-deploy)
66
[![Software License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/techpivot/phalcon-ci-installer/master/LICENSE)
77

8-
9-
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
10-
the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html).
8+
This script deploys applications with the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) service. The script uses the AWS CLI for underlying commands and extends functionality to provide common requirements for applications being deployed including compression, encryption, bucket revision limiting, monitoring, and more. It also handles creation of defined AWS Code Deploy components as necessary (e.g. Deployment Groups). By utilizing environment variables, this script is easily portable and intended to run inside CI containers. For more information, refer to the [AWS Code Deploy](http://docs.aws.amazon.com/codedeploy/latest/userguide/welcome.html) documentation or the [AWS CLI API](http://docs.aws.amazon.com/cli/latest/reference/deploy/index.html).
119

1210
### Features:
13-
* Minimal dependencies: aws (If not installed automatically installed)
14-
* Compression of source contents
11+
* One dependency: AWS CLI (Automatically installed if not available)
12+
* Automatically compress source directory
1513
* Ability to limit the number of stored revisions by a key prefix to help reduce S3 total file size
1614
* Server side encryption for revisions
1715
* Full diagnostic output from failed instances
@@ -79,25 +77,41 @@ Status | In Progress: 0 | Pending: 0 | Skipped: 0 | Succeeded: 1 | Failed:
7977
```
8078

8179

82-
## How to Include In Your Project
80+
## Usage
8381

84-
### Composer (For PHP Projects)
85-
1. Include in `composer.json` as follows:
82+
### Composer (PHP Projects)
83+
1. Include the `techpivot/aws-code-deploy` project from Packagist as a development dependency:
8684

85+
**composer.json**
8786
```json
8887
"require-dev" : {
8988
"techpivot/aws-code-deploy": "~1.0"
9089
}
9190
```
92-
* The file can then be executed from the /vendor/bin directory: `bash vendor/bin/aws-code-deploy.sh`
91+
92+
or via command line:
93+
94+
```bash
95+
composer require --dev techpivot/aws-code-deploy ~1.0
96+
```
97+
98+
2. The file can then be executed directly: `./vendor/bin/aws-code-deploy.sh`
9399

94100
### NPM (General Projects)
101+
Include the `aws-code-deploy` from NPM as a local or global dependency.
102+
103+
#### **Global**
104+
1. `npm install aws-code-deploy -g`
105+
2. The file can then be executed directly: `aws-code-deploy`
106+
107+
#### **Local**
108+
1. `npm install aws-code-deploy`
109+
2. The file can then be executed directly: `./node_modules/aws-code-deploy/bin/aws-code-deploy.sh`
95110

96111

97112
## Environment Variables
98113

99-
Brief summary is listed in the table below. Full descriptions with recommendations can be found by searching
100-
the readme for the variable name.
114+
Environment variables are used to control the deployment actions. A brief summary is listed in the table below. Full descriptions with recommendations can be found by searching the readme for the variable name.
101115

102116
| Variable | Required | Description |
103117
| :---------------------------------------- | :------- | :----------------------------------------------------------|
@@ -160,11 +174,6 @@ deployment:
160174
- bash vendor/bin/aws-code-deploy.sh
161175
```
162176
163-
### TravisCI
164-
165-
### Manual
166-
167-
168177
## IAM Requirements
169178
170179
In order for the script to execute successfully, the specified AWS credentials must be granted the required

0 commit comments

Comments
 (0)