README enhance

README.md

@@ -14,3 +14,56 @@ This library can be bundled into your web application to integrate a Forsta
 Messenger client into your web application.
 
 
+Install
+--------
+The forsta-messenger-client should be included with your webpages javascript.  It can be
+added as its own script tag or included with your existing javascript using some bundling
+software of your choosing, e.g. grunt, webpacket etc.  Depending on your desired installation
+and bundling method there are a few ways to get the forsta-messenger-client.
+
+
+### From public CDN (standalone script tag) [easy]
+Add the following script tag to your site;  Note that this script will be the latest
+version of the forsta-messenger-client and you can not choose when version changes
+happen.
+
+```html
+<script src="https://forstalabs.github.io/forsta-messenger-client/dist/forsta-messenger-client.min.js"></script>
+```
+
+### NPM (for bundler based installs) [medium]:
+
+    npm install forsta-messenger-client
+
+Then include the `node_modules/forsta-messenger-client/dist/forsta-messenger-client.js` file
+into your javascript bundle.
+
+
+### Building from source [hard]:
+
+    git clone https://github.com/ForstaLabs/forsta-messenger-client
+    cd forsta-messenger-client
+    npm install
+
+To generate a build from the `src/` files run:
+
+    npm run build
+
+To generate docs:
+
+    npm run docs
+
+Docs are located in the `docs/forsta-messenger-client/<version>` folder.
+
+
+Usage:
+--------
+See our generated reference docs for full usage details:
+https://forstalabs.github.io/forsta-messenger-client/docs/index.html
+
+
+License
+--------
+Licensed under the MIT License.
+
+* Copyright 2019 Forsta Inc.

docs/forsta-messenger-client/0.1.0/index.html

@@ -64,7 +64,23 @@ <h3>forsta-messenger-client 0.1.0</h3>
 <a href="https://forstalabs.github.io/forsta-messenger-client/docs/index.html"><img src="https://img.shields.io/badge/docs-api-lightgrey.svg" alt="Docs"></a></p>
 <h2>About</h2>
 <p>This library can be bundled into your web application to integrate a Forsta
-Messenger client into your web application.</p></article>
+Messenger client into your web application.</p>
+<h2>Install</h2>
+<p>The forsta messenger client should be included with your webpages javascript.  It can be
+added as its own script tag or included with your existing javascript using some bundling
+software of your choosing, e.g. grunt, webpacket etc.  Depending on your desired installation
+and bundling method there are a few ways to get the forsta messenger client.</p>
+<h3>From public CDN (standalone script tag) [easy]</h3>
+<p>Add the following script tag to your site;  Note that this script will be the latest
+version of the forsta-messenger-client and you can not choose when version changes
+happen.</p>
+<pre class="prettyprint source lang-html"><code>&lt;script src=&quot;https://forstalabs.github.io/forsta-messenger-client/dist/forsta-messenger-client.min.js&quot;>&lt;/script>
+</code></pre>
+<h3>NPM (for bundler based installs) [medium]:</h3>
+<pre><code>npm install forsta-messenger-client
+</code></pre>
+<p>Then include the <code>node_modules/forsta-messenger-client/dist/forsta-messenger-client.js</code> file
+into your javascript bundle.</p></article>
     </section>
 
 

package.json

@@ -14,6 +14,7 @@
   },
   "homepage": "https://github.com/ForstaLabs/forsta-messenger-client#readme",
   "scripts": {
+    "build": "grunt",
     "docs": "jsdoc -c .jsdoc.conf src"
   },
   "devDependencies": {