Alexandre Jacques <alexandre.jacques@enabling.com.br>
Committer
Marc Cornellà <marc.cornella@live.com>
Date
Message
django: add README (#7181)
Diff
1diff --git a/plugins/django/README.md b/plugins/django/README.md
2new file mode 100644
3index 0000000000000000000000000000000000000000..415f6b7eaaaa0de1a836bb6aa71745c7b9a619f6
4--- /dev/null
5+++ b/plugins/django/README.md
6@@ -0,0 +1,56 @@
7+# Django plugin
8+
9+This plugin adds completion and hints for the [Django Project](https://www.djangoproject.com/) `manage.py` commands
10+and options.
11+
12+To use it, add `django` to the plugins array in your zshrc file:
13+
14+```zsh
15+plugins=(... django)
16+```
17+
18+## Usage
19+
20+```zsh
21+$> python manage.py (press <TAB> here)
22+```
23+
24+Would result in:
25+
26+```zsh
27+cleanup -- remove old data from the database
28+compilemessages -- compile .po files to .mo for use with gettext
29+createcachetable -- creates table for SQL cache backend
30+createsuperuser -- create a superuser
31+dbshell -- run command-line client for the current database
32+diffsettings -- display differences between the current settings and Django defaults
33+dumpdata -- output contents of database as a fixture
34+flush -- execute 'sqlflush' on the current database
35+inspectdb -- output Django model module for tables in database
36+loaddata -- install the named fixture(s) in the database
37+makemessages -- pull out all strings marked for translation
38+reset -- executes 'sqlreset' for the given app(s)
39+runfcgi -- run this project as a fastcgi
40+runserver -- start a lightweight web server for development
41+...
42+```
43+
44+If you want to see the options available for a specific command, try:
45+
46+```zsh
47+$> python manage.py makemessages (press <TAB> here)
48+```
49+
50+And that would result in:
51+
52+```zsh
53+--all -a -- re-examine all code and templates
54+--domain -d -- domain of the message files (default: "django")
55+--extensions -e -- file extension(s) to examine (default: ".html")
56+--help -- display help information
57+--locale -l -- locale to process (default: all)
58+--pythonpath -- directory to add to the Python path
59+--settings -- python path to settings module
60+...
61+```
62+