From: Angus Salkeld <asalkeld@redhat.com>
Date: Tue, 13 Mar 2012 11:27:42 +0000 (+1100)
Subject: Add simple readme
X-Git-Tag: 2014.1~2219
X-Git-Url: https://review.fuel-infra.org/gitweb?a=commitdiff_plain;h=38de4d2564b75316ef5a61eb0b1a87b22a19731c;p=openstack-build%2Fheat-build.git

Add simple readme

Signed-off-by: Angus Salkeld <asalkeld@redhat.com>
---

diff --git a/README b/README
new file mode 100644
index 00000000..6d5b912f
--- /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
+