Commits

Svyatoslav Bulbakha  committed b51432b

Move from md to rst README

  • Participants
  • Parent commits b2117e1

Comments (0)

Files changed (3)

File README.md

-# Django CKEd
-
-**CKEditor and elFinder integration for Django Framework.**
-
-Provides a `RichTextField` and `CKEditorWidget` with upload and
-browse support.
-
-
-![CKEditor](https://bitbucket.org/ssbb/django-cked/raw/default/img/ckeditor.jpg)
-![elFinder](https://bitbucket.org/ssbb/django-cked/raw/default/img/elfinder.jpg)
-
-## Installation
-
-    pip install django-cked
-
-or
-
-    pip install -e hg+https://bitbucket.org/ssbb/django-cked#egg=django-cked
-
-
-## Configuration
-
-Add `cked` to your `INSTALLED_APPS` setting.
-
-Then set `ELFINDER_OPTIONS` in your settings:
-
-    :::python
-    ELFINDER_OPTIONS = {
-        ## required options
-        'root': os.path.join(PROJECT_ROOT, 'media', 'uploads'),
-        'URL': '/media/uploads/',
-    }
-
-And add CKEd URL include to your project `urls.py` file:
-
-    :::python
-    url(r'^cked/', include('cked.urls')),
-
-## Settings
-
-- **CKEDITOR_OPTIONS**: CKEditor config.
-    See [http://docs.ckeditor.com/#!/guide/dev_configuration](http://docs.ckeditor.com/#!/guide/dev_configuration)
--  **ELFINDER_OPTIONS**: elFinder config.
-    See [https://github.com/Studio-42/elFinder/wiki/Client-configuration-options](https://github.com/Studio-42/elFinder/wiki/Client-configuration-options)
-
-
-## Usage
-
-### Model field
-
-    :::python
-    from django.db import models
-    from cked.fields import RichTextField
-
-
-    class Entry(models.Model):
-        text = RichTextField()
-
-### Widget
-
-    :::python
-    from django import forms
-    from cked.widgets import CKEditorWidget
-
-    class MyForm(forms.Form):
-        text = forms.CharField(widget=CKEditorWidget)
-
-
-**NOTE**: If you are using custom forms, dont’r forget to include form
-media to your template:
-
-    {{ form.media }}
+Django CKEd
+===========
+
+**CKEditor and elFinder integration for Django Framework.**
+
+Provides a ``RichTextField`` and ``CKEditorWidget`` with upload and
+browse support.
+
+|CKEditor| |elFinder|
+
+Installation
+------------
+
+::
+
+    pip install django-cked
+
+or
+
+::
+
+    pip install -e hg+https://bitbucket.org/ssbb/django-cked#egg=django-cked
+
+Configuration
+-------------
+
+Add ``cked`` to your ``INSTALLED_APPS`` setting.
+
+Then set ``ELFINDER_OPTIONS`` in your settings:
+
+::
+
+    :::python
+    ELFINDER_OPTIONS = {
+        ## required options
+        'root': os.path.join(PROJECT_ROOT, 'media', 'uploads'),
+        'URL': '/media/uploads/',
+    }
+
+And add CKEd URL include to your project ``urls.py`` file:
+
+::
+
+    :::python
+    url(r'^cked/', include('cked.urls')),
+
+Settings
+--------
+
+-  **CKEDITOR\_OPTIONS**: CKEditor config. See
+   http://docs.ckeditor.com/#!/guide/dev_configuration
+-  **ELFINDER\_OPTIONS**: elFinder config. See
+   https://github.com/Studio-42/elFinder/wiki/Client-configuration-options
+
+Usage
+-----
+
+Model field
+~~~~~~~~~~~
+
+::
+
+    :::python
+    from django.db import models
+    from cked.fields import RichTextField
+
+
+    class Entry(models.Model):
+        text = RichTextField()
+
+Widget
+~~~~~~
+
+::
+
+    :::python
+    from django import forms
+    from cked.widgets import CKEditorWidget
+
+    class MyForm(forms.Form):
+        text = forms.CharField(widget=CKEditorWidget)
+
+**NOTE**: If you are using custom forms, dont’r forget to include form
+media to your template:
+
+::
+
+    {{ form.media }}
+
+.. |CKEditor| image:: https://bitbucket.org/ssbb/django-cked/raw/default/img/ckeditor.jpg
+.. |elFinder| image:: https://bitbucket.org/ssbb/django-cked/raw/default/img/elfinder.jpg
     keywords='django, ckeditor, elfinder, wysiwyg, upload',
     url='https://bitbucket.org/ssbb/django-cked',
     packages=find_packages(),
-    long_description=read('README.md')
+    long_description=read('README.rst')
 )