v1.0.4 Release samples README and Travis update

Author: Francois-Xavier Gentilhomme

.gitignore

@@ -3,6 +3,7 @@
 *.xml
 *.idea
 .tmp
+release.sh
 node_modules
 bower_components
 test_results

.travis.yml

@@ -3,7 +3,7 @@ node_js:
 - '0.10'
 before_install: npm install -g grunt-cli
 install: npm install && bower install
-before_script: grunt build && grunt compress
+before_script: grunt
 deploy:
 - provider: npm
   email: myscriptjs@myscript.com

Gruntfile.js

@@ -91,12 +91,9 @@ module.exports = function (grunt) {
         concat: {
             default: {
                 options: {
-                    sourceMap: true
+                    sourceMap: true,
+                    banner: '/*\n <%= pkg.name %> - <%= pkg.description %>\n Version: <%= pkg.version %>\n License: <%= pkg.license %>\n */\n'
                 },
-                src: '<%= fileList %>',
-                dest: '<%= project.tmp %>/<%= pkg.name %>.js'
-            },
-            raw: {
                 src: '<%= fileList %>',
                 dest: '<%= project.dist %>/<%= pkg.name %>.js'
             }
@@ -107,14 +104,15 @@ module.exports = function (grunt) {
                 mangle: false,
                 nonull: true,
                 sourceMap: true,
-                sourceMapIn: '<%= project.tmp %>/<%= pkg.name %>.js.map',
+                sourceMapIncludeSources: false,
+                sourceMapIn: '<%= project.dist %>/<%= pkg.name %>.js.map',
                 banner: '/*\n <%= pkg.name %> - <%= pkg.description %>\n Version: <%= pkg.version %>\n License: <%= pkg.license %>\n */'
             },
             default: {
                 files: [{
                     expand: true,
                     flatten: true,
-                    cwd: '<%= project.tmp %>',
+                    cwd: '<%= project.dist %>',
                     src: '<%= pkg.name %>.js',
                     dest: '<%= project.dist %>',
                     ext: '.min.js'
@@ -206,15 +204,16 @@ module.exports = function (grunt) {
                         'cryptojslib/components/hmac-min.js',
                         'q/q.js'
                     ]
-                }]
-            },
-            readme: {
-                files: [{
+                }, {
                     expand: true,
                     dot: true,
-                    cwd: '',
-                    dest: '<%= project.dist %>',
-                    src: ['README.md']
+                    flatten: true,
+                    cwd: '<%= project.dist %>',
+                    dest: '<%= project.dist %>/<%= project.samples %>/lib',
+                    src: [
+                        'myscript.min.js',
+                        'myscript.min.js.map'
+                    ]
                 }]
             }
         },
@@ -236,13 +235,6 @@ module.exports = function (grunt) {
                 }
             }
         },
-        // Run some tasks in parallel to speed up the build process
-        concurrent: {
-            default: [
-                'build',
-                'docs'
-            ]
-        },
         compress: {
             tgz: {
                 options: {
@@ -254,6 +246,7 @@ module.exports = function (grunt) {
                 cwd: '',
                 src: [
                     '<%= project.dist %>/<%= pkg.name %>.js',
+                    '<%= project.dist %>/<%= pkg.name %>.js.map',
                     '<%= project.dist %>/<%= pkg.name %>.min.js',
                     '<%= project.dist %>/<%= pkg.name %>.min.js.map',
                     'THIRD _PARTY_SOFTWARE_AND_LICENCES.md',
@@ -272,6 +265,7 @@ module.exports = function (grunt) {
                 cwd: '',
                 src: [
                     '<%= project.dist %>/<%= pkg.name %>.js',
+                    '<%= project.dist %>/<%= pkg.name %>.js.map',
                     '<%= project.dist %>/<%= pkg.name %>.min.js',
                     '<%= project.dist %>/<%= pkg.name %>.min.js.map',
                     'THIRD _PARTY_SOFTWARE_AND_LICENCES.md',
@@ -320,15 +314,30 @@ module.exports = function (grunt) {
                     dest: '/'
                 }]
             }
+        },
+        // Run some tasks in parallel to speed up the build process
+        concurrent: {
+            default: [
+                'build',
+                'docs',
+                'samples'
+            ],
+            release: [
+                'compress:zip',
+                'compress:tgz',
+                'compress:samples_zip',
+                'compress:samples_tgz'
+            ]
         }
     });
 
     grunt.registerTask('default', [
         'clean:default',
         'jshint:default',
-        'test-unit',
-        'concurrent',
-        'copy:readme'
+        'test',
+        'build',
+        'copy:samples',
+        'concurrent:release'
     ]);
 
     grunt.registerTask('test', [
@@ -345,21 +354,15 @@ module.exports = function (grunt) {
         'clean:tmp',
         'concat',
         'uglify',
-        'concat:raw',
         'clean:tmp'
     ]);
 
-    grunt.registerTask('release', [
-        'compress'
-    ]);
-
     grunt.registerTask('docs', [
         'clean:tmp',
         'copy:template',
         'copy:styles',
         'copy:conf',
         'yuidoc',
-        'copy:samples',
         'clean:tmp'
     ]);
 

README.md

@@ -1,7 +1,12 @@
-# MyScriptJS [![Build Status](https://travis-ci.org/MyScript/MyScriptJS.svg?branch=v0.0.4)](https://travis-ci.org/MyScript/MyScriptJS)
+# MyScriptJS
 
 [MyScriptJS](http://myscript.github.io/MyScriptJS/) is a free and open-source JavaScript library providing an easy way to use [MyScript Cloud]( https://dev.myscript.com/dev-kits/cloud-development-kit/) handwriting recognition in your app.
 
+ [![Build Status](https://travis-ci.org/MyScript/MyScriptJS.svg?branch=master)](https://travis-ci.org/MyScript/MyScriptJS)
+ [![GitHub version](https://badge.fury.io/gh/MyScript%2FMyScriptJS.svg)](http://badge.fury.io/gh/MyScript%2FMyScriptJS)
+ [![Bower version](https://badge.fury.io/bo/myscript.svg)](http://badge.fury.io/bo/myscript)
+ [![npm version](https://badge.fury.io/js/myscript.svg)](http://badge.fury.io/js/myscript)
+
 [MyScriptJS](http://myscript.github.io/MyScriptJS/) speeds up the development of handwriting interfaces with JavaScript, by abstracting and providing default implementations for the common tasks that need to be managed:
 
 * **Ink management**: Store strokes and benefit from a built-in undo/redo system.

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "myscript",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "./dist/myscript.js",
   "description": "MyScriptJS is a free and open-source JavaScript library providing the easiest way to use MyScript Cloud handwriting recognition in your web app",
   "keywords": [
@@ -36,6 +36,6 @@
   },
   "dependencies": {
     "cryptojslib": "3.1.x",
-    "q": "1.0.x"
+    "q": "1.2.x"
   }
 }

dist/myscript.js

@@ -1,6 +1,6 @@
 {
   "name": "myscript",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "./dist/myscript.js",
   "description": "MyScriptJS is a free and open-source JavaScript library providing the easiest way to use MyScript Cloud handwriting recognition in your web app",
   "keywords": [

dist/myscript.js.map

@@ -0,0 +1,39 @@
+# MyScriptJS
+
+Welcome to the [MyScript](https://www.myscript.com) JavaScript framework.
+
+Learn more in the [Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html) and the [API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html).
+
+## Installation
+
+**Browser**: Use our [CDN](https://cdnjs.com/libraries/myscript) or [Download](https://github.com/MyScript/MyScriptJS/releases/latest) the latest `myscript.js`
+
+**Bower**: `bower install myscript`
+
+**Node**:  `npm install myscript`	
+
+## Getting started
+
+This tutorial shows how to perform the recognition of a digital handwritten
+sample with MyScript. It gives the main steps to follow, based on the provided [code samples](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples).
+
+### Generate your keys
+
+A valid MyScript Cloud account is necessary to use MyScriptJS.
+To create a MyScript Cloud account, look at [MyScript Developer Portal](https://dev.myscript.com/developer-program/register/).
+
+1. [Login](https://cloud.myscript.com) to your Cloud account
+2. Create an application
+3. Generate an application and an HMAC key
+
+Store your keys for later use.
+
+__No handwriting recognition can be processed without these keys__.
+
+### Follow the tutorial
+
+- [Analyzer recognition](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples/analyzer#create-your-html5-canvas)
+- [Math recognition](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples/math#create-your-html5-canvas)
+- [Music recognition](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples/music#create-your-html5-canvas)
+- [Shape recognition](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples/shape#create-your-html5-canvas)
+- [Text recognition](https://github.com/MyScript/MyScriptJS/tree/master/resources/samples/text#create-your-html5-canvas)

dist/myscript.min.js

@@ -2,11 +2,11 @@
 
 Welcome to the [MyScript](https://www.myscript.com) JavaScript framework.
 
-Learn more in the [Developer Guide](http://doc.myscript.com/MyScriptJS/DeveloperGuide/index.html) and the [API Reference](http://doc.myscript.com/MyScriptJS/API_Reference/index.html).
+Learn more in the [Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html) and the [API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html).
 
 ## Installation
 
-**Browser**: Download the latest `myscript.js` from our [Developer Portal](https://dev.myscript.com).
+**Browser**: Use our [CDN](https://cdnjs.com/libraries/myscript) or [Download](https://github.com/MyScript/MyScriptJS/releases/latest) the latest `myscript.js`
 
 **Bower**: `bower install myscript`
 
@@ -107,7 +107,7 @@ Besides, the pointerId variable needs to be added: Its role is make sure that ev
 </html>
 ```
 
-### Create a [Renderer](http://doc.myscript.com/MyScriptJS/API_Reference/classes/AnalyzerRenderer.html)
+### Create a [Renderer](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRenderer.html)
 
 You need to create a renderer to draw strokes on your canvas. To do so, provide the renderer with canvas context (size, background, etc.) and ink coordinates.<br>The renderer that you define depends on the type of recognition you want to achieve.
 
@@ -157,9 +157,9 @@ You need to create a renderer to draw strokes on your canvas. To do so, provide
 ```
 
 
-### Create a [InkManager](http://doc.myscript.com/MyScriptJS/API_Reference/classes/InkManager.html)
+### Create a [InkManager](http://myscript.github.io/MyScriptJS/api-reference/classes/InkManager.html)
 
-You need to build a stroker to catch and store the drawn strokes. The stroker will transform them into proper [MyScript Strokes](http://doc.myscript.com/MyScriptJS/API_Reference/classes/Stroke.html) to use them as input components for the recognition process. Note that the undo/redo feature is not possible without a stroker.
+You need to build a stroker to catch and store the drawn strokes. The stroker will transform them into proper [MyScript Strokes](http://myscript.github.io/MyScriptJS/api-reference/classes/Stroke.html) to use them as input components for the recognition process. Note that the undo/redo feature is not possible without a stroker.
 
 ```javascript
 (function() {
@@ -211,7 +211,7 @@ You need to build a stroker to catch and store the drawn strokes. The stroker wi
 })();
 ```
 
-### Create a [Recognizer](http://doc.myscript.com/MyScriptJS/API_Reference/classes/AnalyzerRecognizer.html)
+### Create a [Recognizer](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html)
 
 You need to create the last object, namely the recognizer. Its role is to manage the recognition within MyScript JS by sending requests and receiving responses to and from MyScript Cloud. The recognizer that you define depends on the type of recognition you want to achieve.
 
@@ -227,7 +227,7 @@ var analyzerRecognizer = new MyScript.AnalyzerRecognizer();
 
 ### Launch the recognition
 
-To launch the recognition process, gather your input components and call the method [`doSimpleRecognition`](http://doc.myscript.com/MyScriptJS/API_Reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition).<br>
+To launch the recognition process, gather your input components and call the method [`doSimpleRecognition`](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition).<br>
 Reminder: The `applicationKey` and the `hmacKey` are generated at the very beginning.<br>
 The variable `instanceId` is the session identifier: It is used below to check that you are still working on the same session.
 
@@ -248,10 +248,10 @@ function doRecognition () {
 
 ### Get the result
 
-Every [`doSimpleRecognition`](http://doc.myscript.com/MyScriptJS/API_Reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition) method returns [Promise](https://github.com/domenic/promises-unwrapping/blob/master/README.md), so you can directly access the output using resolve process. For every recognition type, the result contains the `instanceId` and the recognition document, here a [AnalyzerDocument](http://doc.myscript.com/MyScriptJS/API_Reference/classes/AnalyzerDocument.html).
+Every [`doSimpleRecognition`](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerRecognizer.html#method_doSimpleRecognition) method returns [Promise](https://github.com/domenic/promises-unwrapping/blob/master/README.md), so you can directly access the output using resolve process. For every recognition type, the result contains the `instanceId` and the recognition document, here a [AnalyzerDocument](http://myscript.github.io/MyScriptJS/api-reference/classes/AnalyzerDocument.html).
 For more information on output objects, please refer to the
-[API Reference](http://doc.myscript.com/MyScriptJS/API_Reference/index.html) and
-[Developer Guide](http://doc.myscript.com/MyScriptJS/DeveloperGuide/index.html).
+[API Reference](http://myscript.github.io/MyScriptJS/api-reference/index.html) and
+[Developer Guide](http://myscript.github.io/MyScriptJS/developer-guide/index.html).
 
 ```javascript
 var canvas = document.getElementById("canvas");

dist/myscript.min.js.map

@@ -21,7 +21,7 @@ <h1>Analyzer - Getting started</h1>
 <!-- HandJS import -->
 <script type="text/javascript" src="../../lib/hand.minified-1.3.8.js"></script>
 <!-- MyScriptJS import -->
-<script type="text/javascript" src="../../../myscript.min.js"></script>
+<script type="text/javascript" src="../../lib/myscript.min.js"></script>
 <script>
     (function () {
         var canvas = document.getElementById("canvas");

package.json

@@ -26,7 +26,7 @@ <h1>Analyzer - REST sample</h1>
 <script type="text/javascript" src="../../lib/hmac-min.js"></script>
 <script type="text/javascript" src="../../lib/q.js"></script>
 <script type="text/javascript" src="../../lib/hand.minified-1.3.8.js"></script>
-<script type="text/javascript" src="../../../myscript.min.js"></script>
+<script type="text/javascript" src="../../lib/myscript.min.js"></script>
 <script>
     (function () {
         var canvas = document.getElementById("canvas");