Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

README madness...

  • Loading branch information...
commit 038f0a892c2b79e7b377cdb517881962c16f04bd 1 parent 15515c5
Brandon R. Stoner authored

Showing 1 changed file with 44 additions and 0 deletions. Show diff stats Hide diff stats

  1. +44 0 README.md
44 README.md
Source Rendered
@@ -3,6 +3,22 @@ TastyBone
3 3
4 4 Expose TastyPie to your client. Nicely.
5 5
  6 +Dependencies
  7 +------------
  8 +
  9 +Before including this script, make sure that you have included the following
  10 +scripts in your document. Without them, this thing is going to misbehave like
  11 +you wouldn't believe!
  12 +
  13 +- jQuery
  14 +- underscore.js
  15 +- backbone.js
  16 +
  17 +Note that I did not introduce any of these dependencies (aside from the obvious
  18 +backbone.js dependency). These are all dependencies required by any site using
  19 +backbone.js to grab data over AJAX - which is exactly what we need for
  20 +TastyBone.
  21 +
6 22 How does it work?
7 23 -----------------
8 24
@@ -34,3 +50,31 @@ collection of user models as such:
34 50 }
35 51 });
36 52 };
  53 +
  54 +Django support
  55 +--------------
  56 +
  57 +TastyBone is already in pip, and provides a super simple app that will append
  58 +tastybone.js and tastybone.min.js to your static files. Simply install
  59 +tastybone from pypi with your favorite frontend. Here's how it looks with pip:
  60 +
  61 + pip install tastybone
  62 +
  63 +After this is done installing, append the tastybone module to your
  64 +INSTALLED_APPS setting:
  65 +
  66 + INSTALLED_APPS = (
  67 + # All of your other awesomely fancy apps here.
  68 + 'tastybone',
  69 + )
  70 +
  71 +Now, (after having run `manage.py collectstatic` if necessary) you should be
  72 +able to access *tastybone.js* or *tastybone.min.js* under your STATIC_URL. For
  73 +instance, if STATIC_URL is equal to '/static/' then you'd find the script here:
  74 +
  75 + <script src="/static/scripts/tastypie.min.js"></script>
  76 +
  77 +Things that still need done
  78 +---------------------------
  79 +
  80 +- Proper authentication/authorization support for TastyPie's built-in types.

0 comments on commit 038f0a8

Please sign in to comment.
Something went wrong with that request. Please try again.