Skip to content

Commit

Permalink
Update install notes
Browse files Browse the repository at this point in the history
Fixes #12
  • Loading branch information
paltman committed Jan 2, 2013
1 parent f1944cf commit 2f5d695
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
.. _installation:

Requirements
============

The view to handle the like toggling conforms to an ajax response that
bootstrap-ajax_ understands. Furthermore, the templates that ship with
this project will work seemlessly with bootstrap-ajax. All you have to
do is include the bootstrap-ajax in your base template somewhere like:

{% load staticfiles %}
<script src="{% static "js/bootstrap-ajax.js" %}"></script>

This of course is optional. You can roll your own javascript handling
as the view also returns data in addition to rendered HTML. Furthermore,
if you don't want ajax at all the view will handle a regular POST and
perform a redirect.


Installation
============

Expand Down Expand Up @@ -34,3 +51,5 @@ Installation
...
url(r"^likes/", include("phileo.urls")),
...

:: _bootstrap-ajax: https://github.com/eldarion/bootstrap-ajax

0 comments on commit 2f5d695

Please sign in to comment.