diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 00000000..e6fcf9f9 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,26 @@ +{ + "extends": "airbnb", + "parserOptions": { + "ecmaVersion": 6, + "sourceType": "module", + "ecmaFeatures": { + "jsx": true + } + }, + "rules": { + "semi": 2, + "no-unused-vars" : "off", + "comma-dangle" : "off", + "no-plusplus" : "off", + "no-restricted-properties" : "off", + "prefer-template" : "off", + "import/no-extraneous-dependencies" : "off", + "import/prefer-default-export" : "off", + "max-len": ["off", 100, 2, { + "ignoreUrls": true, + "ignoreComments": false, + "ignoreStrings": true, + "ignoreTemplateLiterals": true + }] + } +} diff --git a/.gitignore b/.gitignore index 5c5054d4..cf60a901 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ bower_components node_modules +!build/docs/node_modules *~ *# *.idea diff --git a/CHANGELOG.md b/CHANGELOG.md index 5f1dcd6c..221b7040 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,23 @@ -# v4.1.1 +# [v5.1.0](https://github.com/MyScript/myscript-text-web/tree/v5.1.0) + +## Features + +- Addition of a new Recognition Assets Builder API to dynamically build text lexicons and math grammars +- Style and decoration support in the JIIX exports +- New configuration options for a finer tuning of JIIX exports +- Always connected is now the default mode for better end user experience + +# [v5.0.0](https://github.com/MyScript/myscript-text-web/tree/v5.0.0) + +## Features + +`myscript-text-web` now supports all the features introduced by the version [4.2.0 of MyScriptJS](https://github.com/MyScript/myscriptjs/tree/v4.2.0). + +## Breaking changes + +- We are now using Polymer 3. For more details, please refer to the [Polymer documentation](https://www.polymer-project.org/3.0/docs/about_30). + +# [v4.1.1](https://github.com/MyScript/myscript-text-web/tree/v4.1.1) ## Bugs fixed - Documentation and paper buttons colors were not taken into account in Edge. diff --git a/README.md b/README.md index 91d76973..af8db1ba 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,23 @@ # MyScript Text Web + +[](https://badge.fury.io/js/myscript-text-web) +[](https://vaadin.com/directory/component/MyScriptmyscript-text-web) +[](https://vaadin.com/directory/component/MyScriptmyscript-text-web) +[](https://www.webcomponents.org/element/MyScript/myscript-text-web) +[](https://myscript.github.io/myscript-text-web/#/elements/myscript-text-web/demos/other-examples) +[](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/) + +## :warning: This repository is archived :warning: +iinkJS grants you high integration flexibility by letting you choose your favorite framework or components. For this reason, we have decided to focus on iinkJS and to discontinue our ready-to-use Web components. + +For more information, please see [documentation](https://developer.myscript.com/). + +We also provide an example to integrate [iinkJS](https://github.com/MyScript/iinkJS) as webcomponent: [link](https://github.com/MyScript/web-integration-samples). + +
@@ -29,9 +48,9 @@ It integrates all you need:
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).
-You can find on our examples page a [simple example](https://myscript.github.io/myscript-text-web/components/myscript-text-web/#/elements/myscript-text-web/demos/get-started-[v4]) of `myscript-text-web`.
+[Simple example](https://myscript.github.io/myscript-text-web/#/elements/myscript-text-web/demos/get-started-[v4]) of `myscript-text-web`.
-We also provide several examples to show the features of `myscript-text-web`. Those examples can be found on our [examples page](https://myscript.github.io/myscript-text-web/components/myscript-text-web/#/elements/myscript-text-web/demos/other-examples) with the source codes in [this directory](https://github.com/MyScript/myscript-text-web/tree/master/examples).
+[All our examples](https://myscript.github.io/myscript-text-web/#/elements/myscript-text-web/demos/other-examples) with the [source codes](https://github.com/MyScript/myscript-text-web/tree/master/src/demo-app/examples).
## Features
@@ -41,21 +60,28 @@ We also provide several examples to show the features of `myscript-text-web`. Th
* Import and export content,
* Styling,
* Typeset support,
-* 59 supported languages.
+* 65 supported languages.
You can discover all the text features on our [Developer website](https://developer.myscript.com/text).
## Requirements
-1. Have [bower](https://bower.io/#install-bower) installed.
+1. Have [npm](https://www.npmjs.com/get-npm) or [yarn](https://yarnpkg.com/en/docs/install) installed.
2. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).
2. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com)
## Installation
-1. Download myscript-text-web.
+Use an existing project or start a fresh one.
+
```shell
-bower install myscript-text-web
+npm init
+```
+
+Install `myscript-text-web` and use it as showed in the [Usage]() section.
+
+```shell
+npm install myscript-text-web
```
## Usage
@@ -63,21 +89,24 @@ bower install myscript-text-web
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
-
-
+
+
```
3. Still in the `head` section, add the following style:
+
```html
```
-4. Use the component in the `body` section with the keys you received by mail.
+4. Use the component in the `body` section with the keys you received by mail.
+
```html