Added pre-release notes

notes/0.2.0.markdown → notes/0.2.6.markdown

@@ -1,7 +1,8 @@
-After stax.net was acquired by CloudBees it made sense to move to the new endpoints etc to ensure on-going usefulness of the plugin in case the stax.net endpoints are ever decommissioned.
+After stax.net was acquired by CloudBees it made sense to move to the new endpoints etc to ensure on-going usefulness of the plugin in case the stax.net endpoints are ever decommissioned. This version is a complete rewrite from the previous version.
 
 Changes:
 
+* If any configuration parameter is not defined, the plugin auto-prompts you for it
 * Now deploy your application with "bees-deploy" in place of "stax-deploy"
 * Rename your staxApplicationId to beesApplicationId
 * Rename your staxUsername to beesUsername

notes/about.markdown

@@ -1,37 +1,46 @@
+CloudBees Run@Cloud SBT Plugin
+------------------------------
+
 Integration for SBT that lets you deploy apps to the CloudBees RUN@Cloud PaaS
 
 Usage
 -----
 
-Define the plugin information in your Plugins.scala
+Firstly, you need to grab the key and secret from grandcentral.cloudbees.com, which should look like:
+
+![Grand Central Keys](https://github.com/timperrett/sbt-cloudbees-plugin/raw/master/notes/img/beehive-keys.jpg)
+
+Once you have these two values, you can do one of two things:
+
+* Enter them when the plugin prompts you; this will be on everytime you run a deployment to the cloud
+* Create a properties file called bees.config in $HOME/.bees/ so that you only need to define them once per computer. This properties file needs to be a key-value pair style like this:
+
+bees.api.key=XXXXXXXXXX
+bees.api.secret=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX=
+
+Whichever route you choose to specify that information, you then only need to define the plugin information in any given project. Specifically, in the Plugins.scala file define the following:
 
 <pre><code>
+  import sbt._
   class Plugins(info: ProjectInfo) extends PluginDefinition(info) {
-    lazy val cloudbees = "eu.getintheloop" % "sbt-cloudbees-plugin" % "0.2.0"
-    lazy val beehive = "cloudbees.repo" 
-      at "http://mvn.stax.net/content/repositories/public"
+    lazy val cloudbees = "eu.getintheloop" % "sbt-cloudbees-plugin" % "0.2.6"
+    lazy val sonatypeRepo = "sonatype.repo" at "https://oss.sonatype.org/content/groups/public"
   }
 </code></pre>
 
 Add the plugin to your SBT project like so:
 
 <pre><code>
-  class YourProject(info: ProjectInfo) 
-      extends DefaultWebProject(info) 
-      with bees.RunCloudPlugin {
-        ....
-        override def beesApplicationId = "whatever"
-        override def beesUsername = "youruser"
-        // leave out and you'll be prompted at deploy time
-        // override def beesPassword = "password"
-      }
+  import sbt._
+  class YourProject(info: ProjectInfo) extends DefaultWebProject(info) with bees.RunCloudPlugin {
+    ....
+    override def beesApplicationId = Some("whatever")
+    override def beesUsername = Some("youruser")
+  }
 </code></pre>
 
-Now your all configured and good to go, just 
-run the deploy action in SBT console:
-
-<code>
-  bees-deploy
-</code>
+Again, if you would prefer to enter these values when you deploy your application then you can of course just enter the appropriate values when prompted. Now your all configured and good to go, there are two commands you can run with this plugin:
 
+* Get a list of your configured applications: <code>bees-applist</code>
+* Deploy your application <code>bees-deploy</code>