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

Commit

Permalink
Improved quick start documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
timorieber committed May 2, 2015
1 parent c52f012 commit 26f5e97
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 4 deletions.
31 changes: 29 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,38 @@ popular Bootstrap UI framework (http://getbootstrap.com).
Quick start
-----------

1. Add ``bootstrap_ui`` to your ``INSTALLED_APPS`` setting
like this::
1. Add ``bootstrap_ui`` to your ``INSTALLED_APPS`` setting::

INSTALLED_APPS = (
...
'bootstrap_ui',
...
)

2. Load ``bootstrap_ui_tags`` in your template::

{% load bootstrap_ui_tags %}

3. Use bootstrap components through intuitive template tags::

{% listgroup %}
{% listgroupitem %}
Your raw text.
{% endlistgroupitem %}
{% listgroupitem %}
You may also use a {{ context_variable }}.
{% endlistgroupitem %}
{% endlistgroup %}

4. Some bootstrap components support different html tags, to change the default add a parameter::

{% listgroup use_tag="div" %}
...
Your list group content goes here.
...
{% endlistgroup %}

Supported bootstrap components
------------------------------

* List group (http://getbootstrap.com/components/#list-group)
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

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

0 comments on commit 26f5e97

Please sign in to comment.