Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README.rst: Start describing django-admin-tools #3

Merged
merged 1 commit into from
Aug 16, 2020
Merged

README.rst: Start describing django-admin-tools #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,17 @@ To get the latest commit from GitHub

TODO: Describe further installation steps (edit / remove the examples below):

Follow installation instructions for https://github.com/django-admin-tools/django-admin-tools

Add ``admintool_command`` to your ``INSTALLED_APPS``

.. code-block:: python

INSTALLED_APPS = (
...,
'admin_tools',
'admin_tools.menu',
'admin_tools.dashboard',
'admintool_command',
)

Expand All @@ -45,6 +50,20 @@ Add the ``admintool_command`` URLs to your ``urls.py``

Usage
-----

Commands need to inherit from `admintool_command.AdminCommand` and
implement at least a `Form` which is used to present the command arguments.

Then these are added to settings like:

.. code-block:: python

ADMIN_TOOLS_COMMANDS = {
'app_name': ['command_name'],
}

Optionally, add `admintool_command.dashboards.AdminCommandMenu` to your django-admin-tools menu.

TODO: Describe about django-admin-tools

TODO: Describe usage or point to docs. Also describe available settings and
Expand Down