aboutsummaryrefslogtreecommitdiff
path: root/sources/plugins/scayt/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'sources/plugins/scayt/README.md')
-rw-r--r--sources/plugins/scayt/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/sources/plugins/scayt/README.md b/sources/plugins/scayt/README.md
new file mode 100644
index 00000000..1231d91e
--- /dev/null
+++ b/sources/plugins/scayt/README.md
@@ -0,0 +1,25 @@
1CKEditor SCAYT Plugin
2=====================
3
4This plugin brings Spell Check As You Type (SCAYT) into up to CKEditor 4+.
5
6SCAYT is a "installation-less", using the web-services of [WebSpellChecker.net](http://www.webspellchecker.net/). It's an out of the box solution.
7
8Installation
9------------
10
111. Clone/copy this repository contents in a new "plugins/scayt" folder in your CKEditor installation.
122. Enable the "scayt" plugin in the CKEditor configuration file (config.js):
13
14 config.extraPlugins = 'scayt';
15
16That's all. SCAYT will appear on the editor toolbar and will be ready to use.
17
18License
19-------
20
21Licensed under the terms of any of the following licenses at your choice: [GPL](http://www.gnu.org/licenses/gpl.html), [LGPL](http://www.gnu.org/licenses/lgpl.html) and [MPL](http://www.mozilla.org/MPL/MPL-1.1.html).
22
23See LICENSE.md for more information.
24
25Developed in cooperation with [WebSpellChecker.net](http://www.webspellchecker.net/).