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

Commit 54b774c

Browse files
committed
[DOCS] Update Readme
1 parent 103a1c4 commit 54b774c

File tree

3 files changed

+106
-39
lines changed

3 files changed

+106
-39
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,9 @@
11
# Contributing
22

3-
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/).
54

65
## Contributor License Agreement
76

87
In order to contribute, you must first agree to the **Contributor License Agreement** available [here](http://goo.gl/forms/YyzZ9VSvYG).
98

109
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).

README.md

Lines changed: 105 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,54 @@
1-
: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.
23
34
<p align="center">
45
<img src="preview.gif">
56
</p>
6-
7-
<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>
8-
97

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.
119

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,
1412
* Digital ink rendering,
13+
* Link to MyScript Cloud to bring handwriting recognition.
14+
15+
## Table of contents
16+
17+
* [Examples](https://github.com/MyScript/myscript-text-web#examples)
18+
* [Features](https://github.com/MyScript/myscript-text-web#features)
19+
* [Requirements](https://github.com/MyScript/myscript-text-web#requirements)
20+
* [Installation](https://github.com/MyScript/myscript-text-web#installation)
21+
* [Usage](https://github.com/MyScript/myscript-text-web#usage)
22+
* [Documentation](https://github.com/MyScript/myscript-text-web#documentation)
23+
* [Support](https://github.com/MyScript/myscript-text-web#support)
24+
* [Feedback](https://github.com/MyScript/myscript-text-web#sharing-your-feedback)
25+
* [Contributing](https://github.com/MyScript/myscript-text-web#contributing)
26+
27+
28+
## Examples
29+
30+
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,
1540
* 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.
1945

20-
## Getting started
46+
You can discover all the text features on our [Developer website](https://developer.myscript.com/text).
2147

22-
### Prerequisites
48+
## Requirements
2349

2450
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/).
2552
2. Get your keys and the free monthly quota to access MyScript Cloud at [developer.myscript.com](https://developer.myscript.com)
2653

2754
## Installation
@@ -30,47 +57,92 @@ myscript-text-web is a web component that can be used in every web application t
3057
```shell
3158
bower install myscript-text-web
3259
```
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.
3466
```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 -->
3867
<link rel="import" href="bower_components/myscript-text-web/myscript-text-web.html">
68+
<script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
69+
<script src="https://code.jquery.com/pep/0.4.3/pep.js"></script>
3970
```
4071

41-
3. Use the component in the `body` section. Use the keys you received by mail.
72+
3. Still in the `head` section, add the following style:
73+
```html
74+
<style>
75+
myscript-text-web {
76+
height: 100%;
77+
}
78+
</style>
79+
```
80+
81+
4. Use the component in the `body` section with the keys you received by mail.
4282
```html
4383
<myscript-text-web
44-
applicationkey="YOUR MYSCRIPT CDK APPLICATION KEY"
45-
hmackey="YOUR MYSCRIPT CDK HMAC KEY">
84+
applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
85+
hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
4686
</myscript-text-web>
4787
```
48-
4. Launch a local web-server and use it!
4988

89+
5. Your `index.html` file should look like this:
90+
```html
91+
<html>
92+
<head>
93+
<link rel="import" href="bower_components/myscript-text-web/myscript-text-web.html">
94+
<script src="bower_components/webcomponentsjs/webcomponents-loader.js"></script>
95+
<script src="https://code.jquery.com/pep/0.4.3/pep.js"></script>
96+
<style>
97+
myscript-text-web {
98+
height: 100%;
99+
}
100+
</style>
101+
</head>
102+
<body>
103+
<myscript-text-web
104+
applicationkey="YOUR MYSCRIPT DEVELOPER APPLICATION KEY"
105+
hmackey="YOUR MYSCRIPT DEVELOPER HMAC KEY">
106+
</myscript-text-web>
107+
</body>
108+
</html>
109+
```
50110

51-
## Examples
52-
53-
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+
```
54115

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/).
56117

57118
## Documentation
58119

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).
60129

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/).
62130

63-
## Contribute
131+
## Getting support
64132

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.
68134

69-
## Share your feedback
135+
## Sharing your feedback
70136

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!
72138
We’re planning to showcase apps using it so let us know by sending a quick mail to [[email protected]](mailto://[email protected])
73139

140+
## Contributing
141+
142+
We welcome your contributions: if you wish to contribute to `myscript-text-web`, feel free to fork it!
143+
144+
Please take a look at our [contributing](CONTRIBUTING.md) guidelines before submitting your pull request.
145+
74146
## License
75147

76-
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0)
148+
This library is licensed under the [Apache 2.0](http://opensource.org/licenses/Apache-2.0).

preview.gif

-78.2 KB
Loading

0 commit comments

Comments
 (0)