Merge lp:~jorge/charms/precise/node-app/fix-node-readme into lp:charms/node-app

[Jorge Castro]

Update the README to reflect the charm store and the name "charm"

[Marco Ceppi (marcoceppi)]

Changes look good, just one thing.

I'd remove the for loop, and instead use `juju add-unit -n10 myapp`

Otherwise, LGTM

review: Approve

[lp:~jorge/charms/precise/node-app/fix-node-readme]

32. By Jorge Castro on 2012-09-17

Of course we don't need a loop with add-unit!

[Juan L. Negron (negronjl)]

I agree with Marco about the loop ( take the loop out and just use -n<n> ).
Other than that, it looks good to me as well.

-Juan

review: Approve

=== modified file 'README.markdown'
--- README.markdown	2011-09-30 20:09:18 +0000
+++ README.markdown	2012-09-17 16:23:20 +0000
@@ -1,44 +1,42 @@
 
-# juju formula to deploy a user-defined node.js app
+# juju charm to deploy a user-defined node.js app
 
 This is an example 
 [juju](http://juju.ubuntu.com)
-formula to deploy a user-defined node app
+charm to deploy a user-defined node app
 directly from revision control.
 
-This formula will be maintained with a general set of hooks
+This charm will be maintained with a general set of hooks
 for various services that can be used with node apps
 (like mongodb).
 
 
-# Using this formula
+# Using this charm
 
 First, edit `config.yaml` to add info about your app.
 
 Then deploy some basic services
 
-    $ juju deploy --repository ~/formulas node-app myapp
-    $ juju deploy --repository ~/formulas mongodb
-    $ juju deploy --repository ~/formulas haproxy
+    juju deploy node-app myapp
+    juju deploy mongodb
+    juju deploy haproxy
 
 relate them
 
-    $ juju add-relation mongodb myapp
-    $ juju add-relation myapp haproxy
-
-scale up your app
-
-    $ for i in {1..10}; do
-    $   juju add-unit myapp
-    $ done
+    juju add-relation mongodb myapp
+    juju add-relation myapp haproxy
+
+scale up your app (to 10 nodes for example)
+
+    juju add-unit -n 10 myapp
 
 open it up to the outside world
 
-    $ juju expose haproxy
+    juju expose haproxy
 
 Find the haproxy instance's public URL from 
 
-    $ juju status
+    juju status
 
 (or attach it to an elastic IP via the aws console)
 and open it up in a browser.
@@ -60,16 +58,16 @@
 - starts your node app as a service
 
 
-## Formula configuration
+## Charm configuration
 
-Configurable aspects of the formula are listed in `config.yaml`
+Configurable aspects of the charm are listed in `config.yaml`
 and can be set by either editing the default values directly
 in the yaml file or passing a `myapp.yaml` configuration
 file during deployment
 
-    $ juju deploy --repository ~/formulas --config ~/myapp.yaml node-app myapp
+    juju deploy --config ~/myapp.yaml node-app myapp
 
-Some of these parameters are used directly by the formula,
+Some of these parameters are used directly by the charm,
 and some are passed through to the node app using `config/config.js`.
 
 ## Application configuration
@@ -104,7 +102,7 @@
 
 ## Network access
 
-This formula does not open any public ports itself.
+This charm does not open any public ports itself.
 The intention is to relate it to a proxy service like
 `haproxy`, which will in turn open port 80 to the outside world.
 This allows for instant horizontal scalability.
@@ -117,7 +115,7 @@
 to the bottom of the `install` hook, and then once your stack
 is started, you expose
 
-    $ juju expose myapp
+    juju expose myapp
 
 it to the outside world.
 
@@ -128,13 +126,13 @@
 
 # Making this work with your node.js app
 
-This formula makes some strong assumptions
+This charm makes some strong assumptions
 about the structure of the node application 
 (`config/config.js`) that might not apply to your app.
 Please treat this formula as a template that 
 you can fork and modify to suit your needs.
 
-The biggest difference between how the formula
+The biggest difference between how the charm
 behaves for different kind of apps is application
 startup.  A simple application will want to start
 upon install (startup code goes in the `install` hook),