Svyatoslav Bulbakha avatar Svyatoslav Bulbakha committed ca08345

Add screenshots

Comments (0)

Files changed (4)

 include README.rst
 recursive-include cked/static *
 recursive-include cked/static *.asp *.php
-recursive-include cked/templates *
+recursive-include cked/templates *
+recursive-exclude img/
 Provides a ``RichTextField`` and ``CKEditorWidget`` with upload and
 browse support.
 
+.. image:: https://bitbucket.org/ssbb/django-cked/src/default/cked/ckeditor.jpg
+.. image:: https://bitbucket.org/ssbb/django-cked/src/default/cked/elfinder.jpg
+
 Installation
 ------------
 
 1. Install or add django-cked to your PYTHONPATH.
    `pip install django-cked` or `-e hg+https://bitbucket.org/ssbb/django-cked`
+   
 2. Add ``cked`` to your ``INSTALLED_APPS`` setting.
-3. Add CKEd URL include to your project ``urls.py`` file:
+
+3. Set ``ELFINDER_OPTIONS`` in your settings:
+
+::
+    ELFINDER_OPTIONS = {
+    ## required options
+        'root': os.path.join(PROJECT_ROOT, 'media', 'uploads'),
+        'URL': '/media/uploads/',
+    }
+4. Add CKEd URL include to your project ``urls.py`` file:
    ``url(r'^cked/', include('cked.urls')),``
 
 Settings
 --------
 
--  **CKED\_UPLOAD\_PATH**: Path to store your uploads. Default:
-   ``os.path.join(MEDIA_ROOT, 'uploads')``
 -  **CKEDITOR\_OPTIONS**: CKEditor config. See
    `http://docs.ckeditor.com/#!/guide/dev\_configuration`_.
 -  **ELFINDER\_OPTIONS**: elFinder config. See
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.