Skip to content

Commit

Permalink
added link to demo and quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
ar4s committed Mar 25, 2016
1 parent 85bd2bd commit bbf569e
Showing 1 changed file with 38 additions and 5 deletions.
43 changes: 38 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,51 @@ Documentation

The full documentation is at https://django-dedal.readthedocs.org.

Demo
----

Example project is available on http://django-dedal.herokuapp.com/.

Quickstart
----------

Install django-dedal::

pip install django-dedal

Then use it in a project::
Then use it in a Django project simple add ``dedal`` and ``bootstrapform`` (if you want use bootstrap) to ``INSTALLED_APPS``::

INSTALLED_APPS = (
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
...
'dedal',
'bootstrapform',
)

After this decorate your model by ``@crud``::

from django.db import models

from dedal.decorators import crud


@crud
class Post(models.Model):
title = models.CharField(max_length=50)
body = models.TextField()
comments = models.ManyToManyField('Comment', blank=True)

import django-dedal
def __str__(self):
return '{}'.format(self.title)

Features
--------
That's all!

* TODO
TODO
----
* pagination
* select related

0 comments on commit bbf569e

Please sign in to comment.