Merge branch 'master' of https://github.com/PredixDev/px-vis-timeseries

README.md

@@ -1,54 +1,66 @@
-Px-Vis-Timeseries
------------------------------------------------
+# px-vis-timeseries
 
 ## Overview
 
-Px-Vis-Timeseries is a Predix Experience ('Px') component
+`Px-vis-timeseries` is a Predix UI component that creates a timeseries chart.
 
 ## Getting Started
 
-From the component's directory...
+First, install the component via bower on the command line:
 
 ```
-$ npm install
-$ bower install
-$ gulp sass
+bower install px-vis-timeseries --save
 ```
 
-### API and examples
+Second, import the component in your application with the following tag in your head:
+
+```
+<link rel="import" href="/bower_components/px-vis-timeseries/px-vis-timeseries.html"/>
+```
 
-From the component's directory
+Finally, use the component in your application:
 
 ```
-$ gulp serve
+See demo page for example usage.
 ```
 
-Starts a local server. Navigate to the root of that server (e.g. http://localhost:8080/) in a browser to open the API documentation page, with link to the "Demo" / working examples.
+<br />
+<hr />
+
+## Documentation
+
+Read the full API and view the demo [here](https://predixdev.github.io/px-vis-timeseries).
 
-### BrowserSync
+The documentation in this repository is supplemental to the official Predix documentation, which is continuously updated and maintained by the Predix documentation team. Go to [http://predix.io](http://predix.io)  to see the official Predix documentation.
 
-By default gulp serve is configured to enable BrowserSync and will be watching for modifications in your root directory as well as `/css`.
 
-### Options
+## Local Development
 
-Does this component have runtime configuration options?  If so, they should be able to be passed as attributes on the element with examples shown below.
+From the component's directory...
 
-### Function calls
+```
+$ npm install
+$ bower install
+$ gulp sass
+```
 
-What is the public API of this component?
+From the component's directory, to start a local server run:
 
-### Extending styles
+```
+$ gulp serve
+```
 
-Documented CSS extension points?
+Navigate to the root of that server (e.g. http://localhost:8080/) in a browser to open the API documentation page, with link to the "Demo" / working examples.
 
-### Extending behavior
 
-See Polymer composition patterns
 
-GE Coding Style Guide
----------------------
 
+### GE Coding Style Guide
 [GE JS Developer's Guide](https://github.com/GeneralElectric/javascript)
 
+<br />
+<hr />
+
+## Known Issues
 
-### Known Issues
+Please use [Github Issues](https://github.com/PredixDev/px-vis-timeseries/issues) to submit any bugs you might find.

demo/index.html

@@ -13,7 +13,7 @@
 <link rel="import" href="../../px-demo/px-demo-code-editor.html" />
 <link rel="import" href="../../px-demo/css/px-demo-styles.html" />
 
-<!-- Imports for this componnent -->
+<!-- Imports for this component -->
 <link rel="import" href="../../px-colors-design/colors.html" />
 <!-- <link rel="import" href="../../px-vis/px-vis-behavior-common.html" />
 <link rel="import" href="../../px-vis/px-vis-behavior-d3.html" />

px-vis-timeseries.html

@@ -30,7 +30,7 @@
 <!--
 Creates an interactive timeseries chart
 
-##### Usage
+### Usage
 
     <px-vis-timeseries options='{ ... }'></px-vis-timeseries>