summaryrefslogtreecommitdiff
path: root/js/ckeditor/plugins/scayt/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'js/ckeditor/plugins/scayt/README.md')
-rw-r--r--js/ckeditor/plugins/scayt/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/js/ckeditor/plugins/scayt/README.md b/js/ckeditor/plugins/scayt/README.md
new file mode 100644
index 0000000..1b3de25
--- /dev/null
+++ b/js/ckeditor/plugins/scayt/README.md
@@ -0,0 +1,25 @@
+CKEditor SCAYT Plugin
+=====================
+
+This plugin brings Spell Check As You Type (SCAYT) into up to CKEditor 4+.
+
+SCAYT is a "installation-less", using the web-services of [WebSpellChecker.net](http://www.webspellchecker.net/). It's an out of the box solution.
+
+Installation
+------------
+
+1. Clone/copy this repository contents in a new "plugins/scayt" folder in your CKEditor installation.
+2. Enable the "scayt" plugin in the CKEditor configuration file (config.js):
+
+ config.extraPlugins = 'scayt';
+
+That's all. SCAYT will appear on the editor toolbar and will be ready to use.
+
+License
+-------
+
+Licensed 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).
+
+See LICENSE.md for more information.
+
+Developed in cooperation with [WebSpellChecker.net](http://www.webspellchecker.net/).