Steve Losh avatar Steve Losh committed 1bffe1a

Update documentation.

Comments (0)

Files changed (1)

     
     pip install -e git://github.com/dwaiter/django-goodfields@stable#egg=django-goodfields
 
-### From Source
+Now symlink (or copy) the templates and media into your project:
+
+    ln -s /path/to/django-goodfields/goodfields/templates/goodfields/ templates/goodfields
+    ln -s /path/to/django-goodfields/goodfields/media/goodfields/ media/goodfields
+
+### Or From Source
 
 Get the code:
 
     cd django-goodfields
     python setup.py install
 
-Usage
------
+Now symlink the templates and media into your project:
 
-django-goodfields can help you render nice form fields, and optionally add
-inline validation with Javascript.
+    ln -s /path/to/django-goodfields/goodfields/templates/goodfields/ templates/goodfields
+    ln -s /path/to/django-goodfields/goodfields/media/goodfields/ media/goodfields
 
-### Field Rendering
+Usage (Field Rendering)
+-----------------------
 
 Use the `{% goodfield [form.field] [field type] %}` template tag to render
 fields in your form:
     </div>
 
 Feel free to customize the templates to look however you prefer. Each field
-type (`text`, `password`, `radio`, etc) has its own template. You can add new
-field types by adding new templates.
+type (`text`, `password`, `radio`, etc) has its own template in
+templates/goodfields. You can add new field types by adding new templates.
+
+django-goodfields will use the `label` attribute of the form field to create
+the `<label>` element by default. You can specify a custom label for a
+particular rendering of a field by using `label "new label"` in the
+`{% goodfield %}` tag, like this:
+
+    <form action="" method="post">
+        {% load goodfields %}
+        {% goodfield form.password password label "Pick a secure password!" %}
+        <input type="submit" value="Sign Up" />
+    </form>
 
 Usage (Inline Validation)
 -------------------------
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.