Skip to content
This repository was archived by the owner on Jan 4, 2021. It is now read-only.

Commit 2c08208

Browse files
author
DEWITTE Pierre-Alban
committed
Updating readme
1 parent 55c97bf commit 2c08208

File tree

1 file changed

+39
-32
lines changed

1 file changed

+39
-32
lines changed

README.md

Lines changed: 39 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,72 @@
1-
# myscript-text-web
2-
3-
The easy way to integrate text handwriting recognition in your web app.
1+
:pencil: The easy way to integrate text handwriting recognition in your web app.
42

53
![myscript-text-web preview](./preview.gif)
64

5+
6+
<a style="text-align:center; font-size:150%;" href="https://myscript.github.io/myscript-text-web/components/myscript-text-web/examples/">Test it live</a>
7+
8+
79
## What is it about?
810

9-
myscript-text-web is a web component that can be used in every web application (whatever javascript framework you are using) to bring handwriting recognition. It integrates all you need:
11+
myscript-text-web is a web component that can be used in every web application to bring handwriting recognition and conversion. It integrates all you need:
1012
* Signal capture,
1113
* Nice digital ink rendering,
12-
* Plug with MyScript CDK to bring handwriting recognition.
14+
* Rich editing gestures,
15+
* Conversion,
16+
* Import (raw text),
17+
* Exports (HTML and raw text).
1318

14-
## Prerequisites
19+
## Getting started
1520

16-
1. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).
17-
2. Get an application key and HMAC key for your application.
18-
3. Import webcomponents polyfill on your webapp.
21+
### Prerequisites
1922

20-
```html
21-
<script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
22-
```
23+
1. Have [bower](https://bower.io/#install-bower) installed.
24+
2. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com)
2325

2426
## Installation
2527

26-
1. Download it.
27-
28-
bower install myscript-text-web
29-
30-
2. Import it on your webapp.
28+
1. Download myscript-text-web.
29+
```shell
30+
bower install myscript-text-web
31+
```
32+
2. Create and edit `index.html` file in the same directory. Add the following line in the head section to import the library.
3133

3234
```html
33-
<link rel="import" href="bower_components/myscript-text-web/myscript-text-web.html">
35+
<!-- Load the webcomponent polyfill -->
36+
<script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
37+
<!-- Load myscript-text-web and the related librairies -->
38+
<link rel="import" href="bower_components/myscript-text-web/myscript-text-web.html">
3439
```
3540

36-
3. Configure it.
41+
3. Use the component in the body section. Use the keys you received by mail.
3742

3843
```html
39-
<myscript-text-web
40-
applicationkey="YOUR MYSCRIPT CDK APPLICATION KEY"
41-
hmackey="YOUR MYSCRIPT CDK HMAC KEY">
42-
</myscript-text-web>
44+
<myscript-text-web
45+
applicationkey="YOUR MYSCRIPT CDK APPLICATION KEY"
46+
hmackey="YOUR MYSCRIPT CDK HMAC KEY">
47+
</myscript-text-web>
4348
```
4449

45-
4. Use it!
50+
4. Launch a local web-server and use it!
51+
4652

47-
[Test it live](https://myscript.github.io/myscript-text-web/components/myscript-text-web/examples/)!
4853

4954
## Examples
5055

51-
- [examples/non-version-specific/get_started.html](examples/non-version-specific/get_started.html) Get started with iink
52-
- [examples/v3/websocket_text.html](examples/v3/websocket_text.html) Get started with legacy api (v3)
53-
- [examples/index.html](examples/index.html) Other demonstrations
54-
55-
## Documentation
56+
Browse [the examples hosted on github.io](https://myscript.github.io/myscript-text-web/examples/).
57+
58+
The [directory examples/](/examples) of this git repository contains all the example source code.
59+
60+
## Documentation
61+
62+
A complete guide is available on [MyScript Developer website](https://developer.myscript.com/docs/interactive-ink/1.0/web/web-components/text-element/).
5663

57-
The API Reference is available here: [https://myscript.github.io/myscript-text-web/](https://myscript.github.io/myscript-text-web/)
64+
The API Reference is available in the `docs` directory or on [myscript.github.io/myscript-text-web/ website](https://myscript.github.io/myscript-text-web/).
5865

5966
## Contribute
6067

6168
We welcome your contributions:
62-
If you would like to extend myscript-text-web for your needs, feel free to fork it!
69+
If you wish to contribute to `myscript-text-web`, feel free to fork it!
6370
Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitting your pull request.
6471

6572
## Share your feedback

0 commit comments

Comments
 (0)