Merge pull request #800 from HelixDesignSystem/HelixUI-v1.x-documentation

feat(v1.x): HelixUI-v1.x documentation

Author: 100stacks

README.md

@@ -1,25 +1,37 @@
 [![Build Status](https://travis-ci.com/HelixDesignSystem/helix-ui.svg?branch=master)](https://travis-ci.com/HelixDesignSystem/helix-ui)
 
 
-# HelixUI
-The HelixUI library provides front-end developers a set of reusable CSS classes and HTML Custom Elements that adhere to Helix design standards.
+# HelixUI Web Components Library
+
+The HelixUI Web Components library provides front-end developers a full suite
+of web components for building UIs.
 
 Adopting the library will enable developers to build products with consistent
 markup, styles, and behavior across a variety of frameworks.
 
-[Homepage](https://helixdesignsystem.github.io/helix-ui/)
-
 ## Documentation
- * [Getting Started](https://helixdesignsystem.github.io/helix-ui/guides/getting-started/)
 
- * [React Compatiblity](https://helixdesignsystem.github.io/helix-ui/guides/react-compatibility/)
+ * Homepage - https://helixdesignsystem.github.io/helix-ui/
+ * Getting Started Guide - https://helixdesignsystem.github.io/helix-ui/guides/getting-started/
+ * NPM Releases - https://www.npmjs.com/package/helix-ui
+
+## Helix-React Wrappers + React Support
+
+ * Our sister repo **Helix-React** - https://github.com/HelixDesignSystem/helix-react - provides
+   React component wrappers to HelixUI.
+ * NPM Releases - https://www.npmjs.com/package/@helix-design-system/helix-react
+ * React Compatiblity with Web Components - https://helixdesignsystem.github.io/helix-ui/guides/react-compatibility/
+
 
 ## Developer Setup
 
-1. [install yarn](https://yarnpkg.com/en/docs/install)
-2. `yarn install` to install project dependencies
-3. `yarn start` to begin working
+1. Install Yarn - https://yarnpkg.com/en/docs/install
+2. `$ git clone [email protected]:HelixDesignSystem/helix-ui.git` (recommended for 2FA setups)
+3. `$ cd helix-ui`
+4. `$ yarn install` to install project dependencies
+5. `$ yarn start`
+6. Navigate to `http://127.0.0.1:3000` in your favorite browser
 
 ## Run Component Test Suite
 
-1. `yarn test` run full component test suite
+1. `$ yarn test` to run the full component test suite

docs/index.html

@@ -6,9 +6,8 @@
 
 {% block page_header %}
   <p>
-    HelixUI is a web UI component library built on top of modern web component
-    standards in order to provide front-end developers a set of reusable CSS
-    classes and HTML Custom Elements that adhere to Helix design standards.
+    HelixUI is a web components library that provides front-end developers with a
+    full suite of web components for building UIs.
   </p>
 {% endblock %}