Skip to content

Commit

Permalink
Added a Usage-section to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
thomst committed Apr 21, 2020
1 parent 0e6e12c commit b048bad
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Welcome to django-admin-csvexport

Description
===========
Django-admin-csvexport is a django-admin-action, that allows you to export a
selection of the fields of your models as csv-formatted data.
Django-admin-csvexport is a django-admin-action, that allows you to export the
items of your django-admin changelist as csv-formatted data.


Features
Expand Down Expand Up @@ -52,6 +52,7 @@ Add csvexport to the actions of your modeladmin::
...
actions = [csvexport]


Configuration
=============
The following settings determine the depth of the model references and the
Expand All @@ -76,3 +77,10 @@ Per default the csv-format can be adjusted by a formular when generating the
csv-file. Set the following setting to False to not render such form::

CSV_EXPORT_FORMAT_FORM = True


Usage
=====
Just use it as any django-admin-action: Select your items, choose csvexport
from the admin-action-bar and go. You will be led to a formular that allows
you to render your items as csv-data.

0 comments on commit b048bad

Please sign in to comment.