Merge pull request #9 from uploadcare/ditch-php

get rid of php

Author: dmitry-mukhin

.gitmodules

@@ -1,92 +1,64 @@
-# Uploadcare CKEDITOR Plugin
+# Uploadcare CKEditor Plugin
 
-This is a plugin for [CKEDITOR][4] to work with [Uploadcare][1].
+This is a plugin for [CKEditor][3] to work with [Uploadcare][1].
 
-It's based on a [uploadcare-php][3] library.
+## Demo
 
-## Requirements
-
-- CKEDITOR 4.0+
-
-## Optional for PHP version.
+Minimalistic demo can be found [here][7].
 
-- [iframedialog][5] plugin for CKEDITOR
-- PHP 5.2+
-- php-curl
+## Requirements
 
-**Note!** PHP implementation is optional by now and we higly recommend not to use it.
+CKEditor 4.0+
 
 ## 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
+Add [plugin](http://ckeditor.com/addon/uploadcare) to CKBuilder or
+clone plugin from git to your plugins directory:
 
-Initialize a CKEDITOR plugin with additional params:
+    git clone git://github.com/uploadcare/uploadcare-ckeditor.git plugins/uploadcare
 
-    <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' ]
-        ]
-      });
+## Configure
 
-    </script>
+Initialize a CKEditor plugin with additional params:
 
-## PHP (Optional)
+```javascript
+UPLOADCARE_PUBLIC_KEY = "demopublickey"; // set public key for Uploadcare
+UPLOADCARE_LOCALE = 'ru'; // set locale if you wish
+CKEDITOR.replace( 'editor1', {
+  extraPlugins: 'uploadcare', // this will enable plugin
+  toolbar: [
+    // add Uploadcare button to toolbar, e.g.:
+    ['Bold', 'Italic', '-', 'NumberedList', 'BulletedList', '-', 'Link', 'Unlink', '-', 'Uploadcare']
+  ]
+});
+```
 
-Install iframedialog plugin.
+You can heavily customize widget behavior, i.e. file sources, file validation and much more, please
+read Uploadcare [widget][5] and [javascript API][6] documentation.
 
-Find a "config.php" file inside plugin directory and edit it:
+## File Autostore
 
-    <?php
-    define('UC_PUBLIC_KEY', 'demopublickey');
-    define('UC_SECRET_KEY', 'demoprivatekey');
+"Automatic file storing" **should** be enabled in your project settings.
+Please follow https://uploadcare.com/dashboard/ to ensure.
 
-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.
+If you do not want to enable "Autostore", you can try to use *deprecated* [php-based version][4]
 
 ## 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.
+5. Click "Done". A cropped image will be available inside editor.
 
-### If USE_PHP = true
+## Feedback
 
-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
+Send any feedback or request support at [email protected]
+
+[1]: https://uploadcare.com/
+[2]: https://uploadcare.com/documentation/cdn/
+[3]: http://ckeditor.com
+[4]: https://github.com/uploadcare/uploadcare-ckeditor/tree/php-dialog
+[5]: https://uploadcare.com/documentation/widget/
+[6]: https://uploadcare.com/documentation/javascript_api/
+[7]: https://uploadcare.com/demos/ckeditor/