Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Update install notes

Fixes #12
  • Loading branch information...
commit 2f5d695f1d4de25d7f3baee28a4f42ede028e567 1 parent f1944cf
@paltman paltman authored
Showing with 19 additions and 0 deletions.
  1. +19 −0 docs/installation.rst
View
19 docs/installation.rst
@@ -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
============
@@ -34,3 +51,5 @@ Installation
...
url(r"^likes/", include("phileo.urls")),
...
+
+:: _bootstrap-ajax: https://github.com/eldarion/bootstrap-ajax
Please sign in to comment.
Something went wrong with that request. Please try again.