From 26f5e97b84dad20d3e64946ca55080ab4bccf997 Mon Sep 17 00:00:00 2001 From: Timo Rieber Date: Sun, 3 May 2015 00:18:02 +0200 Subject: [PATCH] Improved quick start documentation --- README.rst | 31 +++++++++++++++++++++++++++++-- setup.py | 4 ++-- 2 files changed, 31 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 2d26de0..4ede8e2 100644 --- a/README.rst +++ b/README.rst @@ -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) \ No newline at end of file diff --git a/setup.py b/setup.py index 1177f73..a76388a 100644 --- a/setup.py +++ b/setup.py @@ -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,