Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Updated MANIFEST.in, added vanilla README

  • Loading branch information...
commit 3e069a13de9df370c0d9421f7098011b5f7c4f6e 1 parent 749ed5b
Jeff Ober authored
Showing with 81 additions and 15 deletions.
  1. +0 −11 MANIFEST
  2. +4 −2 MANIFEST.in
  3. +75 −0 README
  4. +2 −2 setup.py
View
11 MANIFEST
@@ -1,11 +0,0 @@
-LICENSE
-MANIFEST.in
-README.md
-setup.py
-adgeletti/__init__.py
-adgeletti/models.py
-adgeletti/settings.py
-adgeletti/static/adgeletti/adgeletti.js
-adgeletti/static/adgeletti/adgeletti.min.js
-adgeletti/templatetags/__init__.py
-adgeletti/templatetags/adgeletti_tags.py
View
6 MANIFEST.in
@@ -1,5 +1,7 @@
include MANIFEST.in
include LICENSE
include README.md
-recursive-include adgeletti/templatetags *
-recursive-include adgeletti/static *
+include database.sqlite3
+include setup.py
+include tox.ini
+recursive-include adgeletti/ *
View
75 README
@@ -0,0 +1,75 @@
+Adgeletti
+=========
+
+The savior of human kind in general, ad ops in particular.
+
+What is it?
+-----------
+
+Adgeletti is a django app that facilitates an easy integration with [DoubleClick for Publishers](http://www.google.com/doubleclick/publishers/solutions/ad-serving.html "DFP").
+
+Goals
+-----
+
+1. Simplicity
+2. Efficiency
+3. Ease of integration with existing templates
+4. Designed for responsive sites (works fine with non-responsive sites as well)
+5. Separation of ad scheduling, etc. from ad display
+
+Usage
+-----
+
+1. Define the breakpoints that your website's templates will use, in `settings.py` (e.g., `ADGELETTI_BREAKPOINTS = (u'Mobile', u'Tablet', u'768px', ...)`).
+2. Define an `AdSlot` via the admin, providing a label (slot name), and an ad unit ID.
+3. Create an `AdPosition` for your `AdUnit`, selecting a breakpoint and the sizes of ads allowed.
+4. Use the `{% ad...` template tag to tell Adgeletti where in your page to display the ad.
+
+The following examples will work fine with the steps above, after you load the Adgeletti template tags, like a boss.
+
+ {% load adgeletti_tags %}
+
+To display the ad defined above:
+
+ {% ad AD-01 Mobile %}
+
+If the same ad unit should display in the same location for two different break points:
+
+ {% ad AD-01 Mobile Tablet %}
+
+If the same ad unit should display in two different locations for two different break points:
+
+ {% ad AD-01 Mobile %}
+ ...
+ {% ad AD-01 Tablet %}
+
+Finally, at the bottom of the page, another tag outputs the javascript necessary to facilitate displaying the ads:
+
+ {% adgeletti_go %}
+
+Integration
+-----------
+
+Integration is simple. Call the `Adgeletti.display` function, providing the breakpoint you'd like to display ads for.
+
+ // The following would cause any ads in the page with a "Mobile" breakpoint
+ // to be displayed. This should be done within a document ready handler, or
+ // some time after the document ready event has occurred, to ensure the
+ // lucky charms are in order before an ad is displayed.
+ Adgeletti.display('Mobile');
+
+ // Once ads are displayed for a given breakpoint, they can also be hidden,
+ // and redisplayed without triggering a new ad impression. Also worth
+ // noting is that ad impressions don't occur for ads in a given breakpoint
+ // until that breakpoint is displayed using the aforementioned function.
+ // To hide ads for a breakpoint and display ads for another, simply use:
+ Adgeletti.hide('Mobile');
+ Adgeletti.display('Desktop');
+
+Dependencies
+------------
+
+1. Django 1.3
+2. `django.contrib.sites`
+3. JSON support (see [json2.js](https://github.com/douglascrockford/JSON-js "JSON"))
+4. The Google GPT script (e.g. //www.googletagservices.com/tag/js/gpt.js)
View
4 setup.py
@@ -1,5 +1,4 @@
#!/usr/bin/env python
-#from distutils.core import setup
from setuptools import setup, find_packages
@@ -12,7 +11,8 @@
description = ('A truely plugable Django app, providing easy integration '
'of Google GPT ad displaying into your website.'),
version = version,
- author = 'Jeff.Ober and Michael.Angeletti @ CMG Digital [dot] com',
+ author = 'Jeff Ober and Michael Angeletti',
+ author_email = 'Jeff.Ober and Michael.Angeletti @ CMG Digital [dot] com',
url = 'http://github.com/orokusaki/adgeletti/',
classifiers = [
'Environment :: Web Environment',
Please sign in to comment.
Something went wrong with that request. Please try again.