first commit

lib/ckeditor4/plugins/uploadcare/README.md

@@ -0,0 +1,92 @@
+# Uploadcare CKEDITOR Plugin
+
+This is a plugin for [CKEDITOR][4] to work with [Uploadcare][1].
+
+It's based on a [uploadcare-php][3] library.
+
+## Requirements
+
+- CKEDITOR 4.0+
+
+## Optional for PHP version.
+
+- [iframedialog][5] plugin for CKEDITOR
+- PHP 5.2+
+- php-curl
+
+**Note!** PHP implementation is optional by now and we higly recommend not to use it.
+
+## Install
+
+**Warning**: You **must** enable "Automatic file storing" in your account settings.
+Please follow https://uploadcare.com/accounts/settings/ to enable feature.
+
+Clone plugin from git to your plugins directory:
+
+    git clone git://github.com/uploadcare/uploadcare-ckeditor.git plugins/uploadcare --recursive
+
+Initialize a CKEDITOR plugin with additional params:
+
+    <script>
+      UPLOADCARE_PUBLIC_KEY = "demopublickey"; //set publick key for Uploadcare
+      UPLOADCARE_LOCALE = 'ru'; //set locale if you wish
+      CKEDITOR.replace( 'editor1', {
+        extraPlugins: 'uploadcare', // this will enable plugin
+        toolbar: [
+          [ 'Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink', '-', 'Uploadcare' ]
+        ]
+      });
+
+    </script>
+
+## PHP (Optional)
+
+Install iframedialog plugin.
+
+Find a "config.php" file inside plugin directory and edit it:
+
+    <?php
+    define('UC_PUBLIC_KEY', 'demopublickey');
+    define('UC_SECRET_KEY', 'demoprivatekey');
+
+Initialize a CKEDITOR plugin:
+
+    <script>
+      UPLOADCARE_PUBLIC_KEY = "demopublickey"; //set publick key for Uploadcare
+      UPLOADCARE_LOCALE = 'ru'; //set locale if you wish
+      CKEDITOR.replace( 'editor1', {
+        extraPlugins: 'uploadcare,iframedialog', // this will enable plugin. Iframedialog must be enabled in this case!
+        USE_PHP: true, //this will enable outdated PHP dialog
+        toolbar: [
+          [ 'Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink', '-', 'Uploadcare' ]
+        ]
+      });
+
+    </script>
+
+PHP Version provides an outdated custom dialog. This dialog is used to store files and images and
+provides some additional image operations.
+
+## Usage
+
+### if USE_PHP = false
+
+1. Press "Uploadcare" button.
+2. Select a file to upload and press "Upload"
+3. Wait for file to be uploaded.
+4. Crop an image as you wish.
+5. Press "Upload" again. A cropped image will be available inside editor.
+
+### If USE_PHP = true
+
+1. Press "Uploadcare" button.
+2. Select a file to upload.
+3. Wait for file to be uploaded. An "Uploadcare" icon will show upload progress.
+4. Change any parameters you like.
+5. Press "Insert" and an image will be available inside editor.
+
+[1]: http://uploadcare.com/
+[2]: https://uploadcare.com/documentation/reference/basic/cdn.html
+[3]: https://github.com/uploadcare/uploadcare-php
+[4]: http://www.ckeditor.com
+[5]: http://www.ckeditor.com/addon/iframedialog