Merge pull request #3 in WS/webcomponents-myscript-common-element from wip-readme to master

* commit '2ac49128e46683493b5a1565e5be5723f560560d':
  [FIX] Remove pep from readme
  [DOCS] Update Readme

Author: RomainCscn

CONTRIBUTING.md

@@ -6,8 +6,4 @@ We gladly welcome pull requests to myscript-common-element. If you have any ques
 
 In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
 
-Make sure you read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the contributing process.
-
-## License
-
-This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).
+Make sure you read the article "[Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)" to understand the contributing process.

README.md

@@ -1,77 +1,146 @@
-`myscript-common-element` is the common layer of [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web). 
-It helps you to integrate an ink editor and handwriting recognition in your **Polymer** webapp.
- 
-## What is it about?
+# MyScript Common Element
+> The common layer of [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web). 
+
+<div align="center">
+  <img src="preview.gif">
+</div>
+
+`myscript-common-element` is a Web component that can be used in every web application to bring handwriting recognition and conversion. 
 
-myscript-common-element is a web component that can be used in every web application to bring handwriting recognition and conversion. It integrates all you need:
-* Signal capture,
+It integrates all you need:
+* Signal capture for all devices,
 * Digital ink rendering,
-* Rich editing gestures,
-* Conversion,
-* Import,
-* Exports.
+* Link to MyScript Cloud to bring handwriting recognition.
 
-Both math and text can be recognized, you just have to define the appropriate configuration settings.
+If you are not familiar with [Web components](https://www.webcomponents.org/) and [Polymer](https://www.polymer-project.org/), please consider using [MyScriptJS](https://github.com/MyScript/MyScriptJS) or our out-of-the-box components [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web).  
 
-If you are not familiar with webcomponents and Polymer, please use [MyScriptJS](https://github.com/MyScript/MyScriptJS) or [myscript-math-web](https://github.com/MyScript/myscript-math-web) and [myscript-text-web](https://github.com/MyScript/myscript-text-web).  
+## Table of contents
 
-## Getting started
+* [Examples](https://github.com/MyScript/myscript-common-element#examples)
+* [Features](https://github.com/MyScript/myscript-common-element#features)
+* [Requirements](https://github.com/MyScript/myscript-common-element#requirements)
+* [Installation](https://github.com/MyScript/myscript-common-element#installation)
+* [Usage](https://github.com/MyScript/myscript-common-element#usage)
+* [Documentation](https://github.com/MyScript/myscript-common-element#documentation)
+* [Support](https://github.com/MyScript/myscript-common-element#support)
+* [Feedback](https://github.com/MyScript/myscript-common-element#sharing-your-feedback)
+* [Contributing](https://github.com/MyScript/myscript-common-element#contributing)
 
-### Prerequisites
+## Examples
 
-1. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).
-2. Get an application key and HMAC key for your application.
-3. Import webcomponents polyfill on your webapp.
+If you're not familiar with MyScript and Interactive Ink, consider discovering its major features with our [text demo and tutorial](http://webdemo.myscript.com/views/text.html).
 
-```html
-    <script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
-```
+You can find on our examples page a [simple text example](https://myscript.github.io/myscript-common-element/components/myscript-common-element/#/elements/myscript-common-element/demos/get-started-[v4]) of `myscript-common-element`. 
+
+We also provide several examples to show the features of `myscript-common-element`. Those examples can be found on our [examples page](https://myscript.github.io/myscript-common-element/components/myscript-common-element/#/elements/myscript-common-element/demos/other-demonstrations) with the source codes in [this directory](https://github.com/MyScript/myscript-common-element/tree/master/examples).
+
+## Features
+
+* Easy to integrate,
+* Digital ink capture and rendering,
+* Rich editing gestures,
+* Import and export content,
+* Styling,
+* Typeset support,
+* More than 200 mathematical symbols supported,
+* 59 supported languages.
+
+You can discover all the features on our Developer website for [Text](https://developer.myscript.com/text) and [Math](https://developer.myscript.com/math).
+
+## Requirements
+
+1. Have [bower](https://bower.io/#install-bower) installed.
+2. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).
+3. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com/getting-started/web)
 
-#### Installation
+## Installation
 
 1. Download myscript-common-element.
 ```shell
 bower install myscript-common-element
 ```
 
-2. Create and edit `index.html` file in the same directory. Add the following line in the `head` section to import the library.
+## Usage
+
+1. Create an `index.html` file in the same directory. 
+
+2. Add the following lines in the `head` section to import the library and the webcomponents polyfill.
 ```html
-  <!-- Load the webcomponent polyfill -->
-  <script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
-  <!-- Load myscript-common-element and the related librairies -->
   <link rel="import" href="bower_components/myscript-common-element/myscript-common-element.html">
+  <script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
+```
+
+3. Still in the `head` section, add the following style:
+```html
+<style>
+    myscript-common-element {
+        height: 100%;
+    }
+</style>
 ```
 
-3. Use the component in the `body` section. Use the keys you received by mail.
+4. Use the component in the `body` section with the keys you received by mail.
 ```html
   <myscript-common-element
-    applicationkey="YOUR MYSCRIPT CDK APPLICATION KEY"
-    hmackey="YOUR MYSCRIPT CDK HMAC KEY">
+    applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
+    hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
   </myscript-common-element>
 ```
 
-4. Launch a local web-server and use it!
-
-
-## Examples
+5. Your `index.html` file should look like this:
+```html
+<html>
+    <head>
+        <link rel="import" href="bower_components/myscript-common-element/myscript-common-element.html">
+        <script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
+        <style>
+            myscript-common-element {
+                height: 100%;
+            }
+        </style>
+    </head>
+    <body>
+      <myscript-common-element
+        applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
+        hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
+      </myscript-common-element>
+    </body>
+</html>
+```
 
-Browse [the examples hosted on github.io](https://myscript.github.io/myscript-common-element/components/myscript-common-element/#/elements/myscript-common-element/demos/other-demonstrations).
+6. Launch a local Web server like the one below and open the page in your browser (at [0.0.0.0:8000](http://0.0.0.0:8000) if you used the one below) to start using it!
+```
+python -m SimpleHTTPServer
+```
 
-The [directory examples/](/examples) of this git repository contains all the example source codes. 
+You can find this guide and a more complete example on the [MyScript Developer website](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/).
 
 ## Documentation
 
-A complete guide is available on [MyScript Developer website](https://developer.myscript.com/docs/interactive-ink/1.0/web/web-components/common-element/).
+You can find a complete documentation with the following sections on our Developer website:
+
+* **Get Started**: [how to use myscript-common-element with a full example](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/get-started/),
+* **Editing**: [how to interact with content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/editing/),
+* **Conversion**: [how to convert your handwritten content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/conversion/),
+* **Import and Export**: [how to import and export your content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/import-and-export/),
+* **Styling**: [how to style content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/common-element/styling/).
 
-The API Reference is available in the `docs` directory or on [myscript.github.io/myscript-common-element/ website](https://myscript.github.io/myscript-common-element/).
+We also provide a complete [API Reference](https://myscript.github.io/myscript-common-element/).
 
-## Contribute
+## Getting support
 
-We welcome your contributions:
-If you would like to extend myscript-common-element for your needs, feel free to fork it!
-Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitting your pull request.
+You can get support and ask your questions on the [dedicated section](https://developer-support.myscript.com/support/discussions/forums/16000096021) of MyScript Developer website.
 
-## Share your feedback
+## Sharing your feedback
 
-Made a cool app with myscript-common-element? We would love to hear about you!
+Made a cool app with `myscript-common-element`? We would love to hear about you!
 We’re planning to showcase apps using it so let us know by sending a quick mail to [[email protected]](mailto://[email protected])
+
+## Contributing
+
+We welcome your contributions: if you would like to extend `myscript-common-element` for your needs, feel free to fork it!
+
+Please take a look at our [contributing](CONTRIBUTING.md) guidelines before submitting your pull request.
+
+## License
+This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).