README.md in lono-0.5.0 vs README.md in lono-0.5.1
- old
+ new
@@ -10,21 +10,22 @@
[1]: http://travis-ci.org/tongueroo/lono
[2]: https://secure.travis-ci.org/tongueroo/lono.png?branch=master
[3]: https://codeclimate.com/repos/51d7f1407e00a4042c010ab4/badges/5273fe6cdb5a13e58554/gpa.png
[4]: https://codeclimate.com/repos/51d7f1407e00a4042c010ab4/feed
-Lono is a Cloud Formation Template ruby generator. Lono generates Cloud Formation templates based on ERB templates.
+Lono is a CloudFormation Template ruby generator. Lono generates CloudFormation templates based on ERB templates.
## Usage
<pre>
-$ lono new lono
+$ lono new infra
</pre>
-This sets up a starter lono project with example templates.
+This sets up a starter lono project called infra with example templates. Next you cd into the folder and generate the templates.
<pre>
+$ cd infra
$ lono generate
</pre>
This generates the templates that have been defined in the config folder of the lono project to the output folder.
@@ -81,11 +82,11 @@
]
]
}
```
-Within the user_data script you can use helper methods that correspond to Cloud Formation [Instrinic Functions](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-intrinsic-functions.html). Currently, base64, find_in_map, get_att, get_azs, join, and ref are supported. Here's a short example of a user_data script using a helper method:
+Within the user_data script you can use helper methods that correspond to CloudFormation [Instrinic Functions](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/concept-intrinsic-functions.html). Currently, base64, find_in_map, get_att, get_azs, join, and ref are supported. Here's a short example of a user_data script using a helper method:
If you have a templates/user_data/db.sh.erb that looks like this:
```bash
#!/bin/bash -lexv
@@ -115,11 +116,11 @@
/usr/bin/redis-server
# If all is well so signal success
/usr/local/bin/cfn-signal -e $? -r "Ready to rock" '<%= ref("WaitHandle") %>'
```
-The user_data helper will transform the bash script into a json array of elements for Cloud Formation:
+The user_data helper will transform the bash script into a json array of elements for CloudFormation:
```json
[
"#!/bin/bash -lexv\n",
"\n",
@@ -175,19 +176,19 @@
More examples of user_data and instrinic function helper method usage are found in the starter [project template](https://github.com/tongueroo/lono/blob/master/lib/starter_project/templates/user_data/db.sh.erb)
## Converting UserData scripts
-You can convert UserData scripts in existing Cloud Formation Templates to a starter bash script via:
+You can convert UserData scripts in existing CloudFormation Templates to a starter bash script via:
<pre>
$ lono bashify cloud_formation_template.json
$ lono bash cloud_formation_template.json # shorthand
$ lono b https://s3.amazonaws.com/cloudformation-templates-us-east-1/LAMP_Single_Instance.template # shorthand and url
</pre>
-This is useful if you want to take an existing [Cloud Formation Template example](http://aws.amazon.com/cloudformation/aws-cloudformation-templates/) and quicklly change the UserData section into a bash script. The bashify command will generate a snippet that is meant to be copied and pasted into a bash script and used with user_data helper method. The bash script should work right off the bat as lono will transform the generated Cloud Formation object references to json objects, there's no need to manually change what is generated to the helper methods, though you can if you prefer the look of the helper methods.
+This is useful if you want to take an existing [CloudFormation Template example](http://aws.amazon.com/cloudformation/aws-cloudformation-templates/) and quicklly change the UserData section into a bash script. The bashify command will generate a snippet that is meant to be copied and pasted into a bash script and used with user_data helper method. The bash script should work right off the bat as lono will transform the generated CloudFormation object references to json objects, there's no need to manually change what is generated to the helper methods, though you can if you prefer the look of the helper methods.
## Breaking up config/lono.rb
If you have a lot of templates, the config/lono.rb file can get unwieldy long. You can break up the lono.rb file and put template defintions in the config/lono directory. Any file in this directory will be automatically loaded. An [example](lib/starter_project/config/lono/api.rb) is in the starter project.
@@ -199,10 +200,18 @@
<pre>
$ lono generate
$ lono g -c # shortcut
</pre>
-The lono init command also sets up guard-lono. Guard-lono continuously generates the cloud formation templates. Just run guard.
+The lono init command also sets up guard-lono. Guard-lono continuously generates the cloudformation templates. Just run guard.
<pre>
$ guard
</pre>
+
+## Extras
+
+There are some helper lono gems also useful for working with CloudFormation:
+
+* [lono-cfn](https://github.com/tongueroo/lono-cfn) - Wrapper cfn tool to quickly create CloudFormation stacks from lono templates and params files.
+* [lono-params](https://github.com/tongueroo/lono-params) - Tool to generate a CloudFormation params json formatted file from a simplier env like file.
+