README.md in cfn-flow-0.0.1 vs README.md in cfn-flow-0.0.3
- old
+ new
@@ -74,26 +74,29 @@
Settings in the configuration file are overridden by environment variables. And
environment variables are overridden by command line arguments.
```
# cfn-flow.yml in the root of your project
+# You can specify an alternative path by setting the CFN_FLOW_CONFIG environment
+# variable.
+#
# All options in this config can be overridden with command line arguments
---
# S3 bucket where templates are uploaded. No default.
-# Override with CFN_FLOW_BUCKET
+# Override with CFN_FLOW_BUCKET env var
bucket: 'my-s3-bucket'
# S3 path prefix. Default: none
-# Override with CFN_FLOW_TO
+# Override with CFN_FLOW_TO env var
to: my/project/prefix
# Local path in which to recursively search for templates. Default: .
-# Override with CFN_FLOW_FROM
+# Override with CFN_FLOW_FROM env var
from: my/local/prefix
# AWS Region
-# Override with AWS_REGION
+# Override with AWS_REGION env var
region: us-east-1 # AWS region
```
#### AWS credentials
@@ -120,14 +123,22 @@
```
{
"Type" : "AWS::CloudFormation::Stack",
"Properties" : {
"TemplateURL" : {
- "Fn::Join" : [ ":",r
+ "Fn::Join" : [ ":",
[ "https://s3.amazonaws.com/my-bucket", {"Ref": "prefix"}, "my-template.json" ]
]
}
}
}
```
-While testing, set the `prefix` parameter to dev prefix like `dev/aaron`. When you're confident your changes work, release them with cfn-flow and change the `prefix` parameter to `release/1.0.0` for production.
+While testing, set the `prefix` parameter to a dev prefix like `dev/aaron`. When you're confident your changes work, release them with cfn-flow and change the `prefix` parameter to `release/1.0.0` for production.
+
+#### Continuous integration
+
+#### Github commit status
+
+#### Minimal AWS credentials
+
+TODO: example IAM policy