Skip to content

Commit

Permalink
Converted the README to reStructuredText.
Browse files Browse the repository at this point in the history
  • Loading branch information
charettes committed Apr 23, 2016
1 parent d122bd7 commit 86d82a4
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 52 deletions.
48 changes: 0 additions & 48 deletions README.markdown

This file was deleted.

48 changes: 48 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
###############
django-colorful
###############

An extension to the Django web framework that provides a database and form
field to accept and store colors in the RGB format.

.. image:: https://travis-ci.org/charettes/django-colorful.svg?branch=master
:target: https://travis-ci.org/charettes/django-colorful

.. image:: https://coveralls.io/repos/charettes/django-colorful/badge.svg?branch=master&service=github
:target: https://coveralls.io/github/charettes/django-colorful?branch=master

************
Installation
************

>>> pip install django-colorful

Make sure ``'colorful'`` is in your `INSTALLED_APPS`:

::

INSTALLED_APPS.append('colorful')

*****
Usage
*****

In order to use a color field you just have to add it to your model definition:

::

from django.db import models
from colorful.fields import RGBColorField

class Tag(models.Model):
color = RGBColorField()

The ``RGBColorField`` class also accepts a ``color`` keyword argument which can
be set to a list of colors that should be visible as preset color palette:

::

color = RGBColorField(colors=['#FF0000', '#00FF00', '#0000FF'])

The ``ColorFieldWidget`` should take care of providing a JavaScript based shim
on browsers that don't support the HTML5 color input .
6 changes: 2 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@

from colorful import VERSION

github_url = 'https://github.com/charettes/django-colorful'

setup(
name='django-colorful',
version='.'.join(str(v) for v in VERSION),
description='An extension to the Django web framework that provides database and form color fields',
long_description=open('README.markdown').read(),
url=github_url,
long_description=open('README.rst').read(),
url='https://github.com/charettes/django-colorful',
author='Simon Charette',
author_email='charette.s@gmail.com',
install_requires=[
Expand Down

0 comments on commit 86d82a4

Please sign in to comment.