Skip to content

Commit

Permalink
Update readme with installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Stef Bastiaansen committed Aug 10, 2017
1 parent b3dc349 commit ff07046
Showing 1 changed file with 18 additions and 2 deletions.
20 changes: 18 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,34 @@ Django UTF-8 Field
:target: https://coveralls.io/github/megasnort/django-utf8field?branch=master
:alt: Coverage

Sometimes you want to only allow the uploading of UTF-8 text files. This library extends the Django FileField by checking if the content of a file is UTF-8. If not, it generates an error in your form.
Sometimes you want to only allow the uploading of UTF-8 text files. This library extends the Django FileField by checking if the content of a file is UTF-8. If not, it generates an error.

Requirements
------------
Django >= 1.8


Installation
------------
::

pip install django-utf8field


Usage
-----

Create a model like you would do normally, but instead of using FileField you use UTF8FileField
Add the app to your settings:

::

INSTALLED_APPS = (
...
'utf8field',
...


Create a model like you would do normally, but instead of using FileField you use UTF8FileField:

::

Expand Down

0 comments on commit ff07046

Please sign in to comment.