Skip to content
This repository was archived by the owner on Feb 11, 2020. It is now read-only.

Commit 26f5e97

Browse files
committed
Improved quick start documentation
1 parent c52f012 commit 26f5e97

File tree

2 files changed

+31
-4
lines changed

2 files changed

+31
-4
lines changed

README.rst

+29-2
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,38 @@ popular Bootstrap UI framework (http://getbootstrap.com).
2020
Quick start
2121
-----------
2222

23-
1. Add ``bootstrap_ui`` to your ``INSTALLED_APPS`` setting
24-
like this::
23+
1. Add ``bootstrap_ui`` to your ``INSTALLED_APPS`` setting::
2524

2625
INSTALLED_APPS = (
2726
...
2827
'bootstrap_ui',
2928
...
3029
)
30+
31+
2. Load ``bootstrap_ui_tags`` in your template::
32+
33+
{% load bootstrap_ui_tags %}
34+
35+
3. Use bootstrap components through intuitive template tags::
36+
37+
{% listgroup %}
38+
{% listgroupitem %}
39+
Your raw text.
40+
{% endlistgroupitem %}
41+
{% listgroupitem %}
42+
You may also use a {{ context_variable }}.
43+
{% endlistgroupitem %}
44+
{% endlistgroup %}
45+
46+
4. Some bootstrap components support different html tags, to change the default add a parameter::
47+
48+
{% listgroup use_tag="div" %}
49+
...
50+
Your list group content goes here.
51+
...
52+
{% endlistgroup %}
53+
54+
Supported bootstrap components
55+
------------------------------
56+
57+
* List group (http://getbootstrap.com/components/#list-group)

setup.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,10 @@
99

1010
setup(
1111
name='django-bootstrap-ui',
12-
version='0.1-alpha1',
12+
version='0.1-alpha2',
1313
packages=find_packages(exclude=['tests']),
1414
include_package_data=True,
15-
license='ISC License',
15+
license='ISC License (ISCL)',
1616
description='This aims to be a powerful Django app to ease the integration of the popular Bootstrap UI framework'
1717
' (http://getbootstrap.com).',
1818
long_description=README,

0 commit comments

Comments
 (0)