]> review.fuel-infra Code Review - openstack-build/heat-build.git/commitdiff
Add simple readme
authorAngus Salkeld <asalkeld@redhat.com>
Tue, 13 Mar 2012 11:27:42 +0000 (22:27 +1100)
committerAngus Salkeld <asalkeld@redhat.com>
Tue, 13 Mar 2012 11:27:42 +0000 (22:27 +1100)
Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
README [new file with mode: 0644]

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..6d5b912
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+
+This is the beginings of a AWS Cloudformation API written
+in the style of an openstack project.
+
+
+Why heat? It makes the clouds raise and keeps them there.
+
+try:
+./bin/heat-api
+
+and in another shell
+./bin/heat create my_stack --template-file=./templates/getting_started.template  --parameters "param1=foo;param2=bar"
+
+References:
+http://docs.amazonwebservices.com/AWSCloudFormation/latest/APIReference/API_CreateStack.html
+http://docs.amazonwebservices.com/AWSCloudFormation/latest/UserGuide/create-stack.html
+