You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jan 4, 2021. It is now read-only.
We gladly welcome pull requests to MyScript Web. If you would like to add or modify new or larger features, see the **Adding features** section below.
4
-
If you have any questions, or need help to solve a problem, feel free to stop by the [#MyScript forum](https://dev.myscript.com/support/forum/).
3
+
We gladly welcome pull requests to MyScript Web. If you have any questions, or need help to solve a problem, feel free to stop by the [#MyScript forum](https://dev.myscript.com/support/forum/).
5
4
6
5
## Contributor License Agreement
7
6
8
7
In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
9
8
10
9
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.
11
-
12
-
## License
13
-
14
-
This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).
:pencil: The easy way to integrate text handwriting recognition in your web app.
1
+
# MyScript Text Web
2
+
> The easy way to integrate text handwriting recognition in your web app.
2
3
3
4
<palign="center">
4
5
<imgsrc="preview.gif">
5
6
</p>
6
-
7
-
<astyle="text-align:center; font-size:150%;"href="https://myscript.github.io/myscript-text-web/components/myscript-text-web/examples/">Test it live</a>
8
-
9
7
10
-
## What is it about?
8
+
`myscript-text-web`is a Web component that can be used in every web application to bring text handwriting recognition and conversion.
11
9
12
-
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:
13
-
* Signal capture,
10
+
It integrates all you need:
11
+
* Signal capture for all devices,
14
12
* Digital ink rendering,
13
+
* Link to MyScript Cloud to bring handwriting recognition.
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).
31
+
32
+
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`.
33
+
34
+
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).
35
+
36
+
## Features
37
+
38
+
* Easy to integrate,
39
+
* Digital ink capture and rendering,
15
40
* Rich editing gestures,
16
-
* Conversion,
17
-
* Import (raw text),
18
-
* Exports (HTML and raw text).
41
+
* Import and export content,
42
+
* Styling,
43
+
* Typeset support,
44
+
* 59 supported languages.
19
45
20
-
## Getting started
46
+
You can discover all the text features on our [Developer website](https://developer.myscript.com/text).
21
47
22
-
### Prerequisites
48
+
##Requirements
23
49
24
50
1. Have [bower](https://bower.io/#install-bower) installed.
51
+
2. Have a MyScript developer account. You can create one [here](https://dev.myscript.com/).
25
52
2. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com)
26
53
27
54
## Installation
@@ -30,47 +57,92 @@ myscript-text-web is a web component that can be used in every web application t
30
57
```shell
31
58
bower install myscript-text-web
32
59
```
33
-
2. Create and edit `index.html` file in the same directory. Add the following line in the `head` section to import the library.
60
+
61
+
## Usage
62
+
63
+
1. Create an `index.html` file in the same directory.
64
+
65
+
2. Add the following lines in the `head` section to import the library, the webcomponents polyfill and PEP. We use [PEP](https://github.com/jquery/PEP) to ensure better browsers compatibilities.
Browse [the examples hosted on github.io](https://myscript.github.io/myscript-text-web/components/myscript-text-web/#/elements/myscript-text-web).
111
+
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!
112
+
```
113
+
python -m SimpleHTTPServer
114
+
```
54
115
55
-
The [directory examples/](/examples) of this Git repository contains all the example source codes.
116
+
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/text-element/get-started/).
56
117
57
118
## Documentation
58
119
59
-
A complete guide is available on [MyScript Developer website](https://developer.myscript.com/docs/interactive-ink/1.0/web/web-components/text-element/).
120
+
You can find a complete documentation with the following sections on our Developer website:
121
+
122
+
***Get Started**: [how to use myscript-text-web with a full example](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/get-started/),
123
+
***Editing**: [how to interact with content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/editing/),
124
+
***Conversion**: [how to convert your handwritten content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/conversion/),
125
+
***Import and Export**: [how to import and export your content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/import-and-export/),
126
+
***Styling**: [how to style content](https://developer.myscript.com/docs/interactive-ink/latest/web/web-components/text-element/styling/).
127
+
128
+
We also provide a complete [API Reference](https://myscript.github.io/myscript-text-web/components/myscript-text-web/#/elements/myscript-text-web).
60
129
61
-
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/).
62
130
63
-
## Contribute
131
+
## Getting support
64
132
65
-
We welcome your contributions:
66
-
If you wish to contribute to `myscript-text-web`, feel free to fork it!
67
-
Please sign our [Contributor License Agreement](CONTRIBUTING.md) before submitting your pull request.
133
+
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.
68
134
69
-
## Share your feedback
135
+
## Sharing your feedback
70
136
71
-
Made a cool app with myscript-text-web? We would love to hear about you!
137
+
Made a cool app with `myscript-text-web`? We would love to hear about you!
0 commit comments