From a669e267608e9dfbcceba494f010d04507019862 Mon Sep 17 00:00:00 2001 From: tzangms Date: Tue, 7 May 2013 16:33:58 +0800 Subject: [PATCH] update README and docs --- README.rst | 55 +------------------------------------------ docs/index.rst | 2 +- docs/install.rst | 61 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 63 insertions(+), 55 deletions(-) create mode 100644 docs/install.rst diff --git a/README.rst b/README.rst index 43ae4a9..cb432f8 100644 --- a/README.rst +++ b/README.rst @@ -6,57 +6,4 @@ Generate twitter-bootstrap form output for django form A simple Django template tag to work with twitter bootstrap ( http://twitter.github.com/bootstrap/ ) -`readthedocs `_ - - -Screenshot ------------ - -.. image:: _static/example.png - - -Installation ------------- - -Install django-bootstrap-form with pip - -.. code-block:: sh - - $ pip install django-bootstrap-form - - - - -Configuration -------------- - -Add 'bootstrapform' to INSTALLED_APPS. - -.. code-block:: python - - INSTALLED_APPS = ( - ... - 'bootstrapform', - ... - ) - - -Usage ------- - -.. code-block:: none - - {% load bootstrap %} - - {{ form|bootstrap }} - - # or use with individual field - - {{ form.|bootstrap }} - To output individual fields - -CHANGELOG ---------- - -- 2013-5-7: - - Add `radio` support for ChoiceField +`Read the Docs `_ diff --git a/docs/index.rst b/docs/index.rst index 39ae908..7e7beac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,7 +10,7 @@ Welcome to django bootstrap form's documentation! :maxdepth: 2 -.. include:: ../README.rst +.. include:: install.rst Indices and tables diff --git a/docs/install.rst b/docs/install.rst new file mode 100644 index 0000000..c07331f --- /dev/null +++ b/docs/install.rst @@ -0,0 +1,61 @@ +===================== +Django bootstrap form +===================== + +Generate twitter-bootstrap form output for django form + +A simple Django template tag to work with twitter bootstrap ( http://twitter.github.com/bootstrap/ ) + + + +Screenshot +----------- + +.. image:: _static/example.png + + +Installation +------------ + +Install django-bootstrap-form with pip + +.. code-block:: sh + + $ pip install django-bootstrap-form + + + + +Configuration +------------- + +Add 'bootstrapform' to INSTALLED_APPS. + +.. code-block:: python + + INSTALLED_APPS = ( + ... + 'bootstrapform', + ... + ) + + +Usage +------ + +.. code-block:: none + + {% load bootstrap %} + + {{ form|bootstrap }} + + # or use with individual field + + {{ form.|bootstrap }} - To output individual fields + +CHANGELOG +--------- + +- 2013-5-7: + + Add `radio` support for ChoiceField