diff --git a/README.md b/README.md index 9ceadaf..05e480d 100644 --- a/README.md +++ b/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 + +``` + +### 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/` 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. diff --git a/docs/forsta-messenger-client/0.1.0/index.html b/docs/forsta-messenger-client/0.1.0/index.html index d6f546b..c3b84d8 100644 --- a/docs/forsta-messenger-client/0.1.0/index.html +++ b/docs/forsta-messenger-client/0.1.0/index.html @@ -64,7 +64,23 @@

forsta-messenger-client 0.1.0

Docs

About

This library can be bundled into your web application to integrate a Forsta -Messenger client into your web application.

+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.

+
<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.

diff --git a/package.json b/package.json index 9267cec..907214d 100644 --- a/package.json +++ b/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": {