]> git.parisson.com Git - django-google-tools.git/commitdiff
Updating the readme and altering the license
authorClinton Ecker <clint@arstechnica.com>
Sun, 5 Apr 2009 21:26:30 +0000 (16:26 -0500)
committerClinton Ecker <clint@arstechnica.com>
Sun, 5 Apr 2009 21:26:30 +0000 (16:26 -0500)
LICENSE [deleted file]
LICENSE.mdown [new file with mode: 0644]
README.mdown [new file with mode: 0644]
USAGE [deleted file]

diff --git a/LICENSE b/LICENSE
deleted file mode 100644 (file)
index d16322c..0000000
--- a/LICENSE
+++ /dev/null
@@ -1,27 +0,0 @@
-Copyright (c) 2008, Clint Ecker
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without 
-modification, are permitted provided that the following conditions are met:
-
-Redistributions of source code must retain the above copyright notice, this 
-list of conditions and the following disclaimer.
-
-Redistributions in binary form must reproduce the above copyright notice, this
-list of conditions and the following disclaimer in the documentation and/or 
-other materials provided with the distribution.
-
-Neither the name of the <ORGANIZATION> nor the names of its contributors may 
-be used to endorse or promote products derived from this software without 
-specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
- DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE 
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file
diff --git a/LICENSE.mdown b/LICENSE.mdown
new file mode 100644 (file)
index 0000000..290be7a
--- /dev/null
@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2009 Clint Ecker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
\ No newline at end of file
diff --git a/README.mdown b/README.mdown
new file mode 100644 (file)
index 0000000..f807c81
--- /dev/null
@@ -0,0 +1,56 @@
+Google Analytics for Django Projects
+====================================
+
+I manage a lot of Django projects that present slightly-different forms to 
+users depending on the site/domain they're visiting.  There's also a bunch of 
+custom submission code that differs from form to form, but that's neither here
+nor there.
+
+I need different Google Analytics codes depending on the sites and after 
+sticking these tags into every single template, I thought it would be cool to 
+be able to manage these Google analytics accounts from the Django admin page. 
+I also added a mode of operation that excludes the admin interface altogether 
+(you can just use the template tag)
+
+###Two modes of operation###
+
+Administering and associating codes with Django `Sites` framework
+=================================================================
+
+1. Add the `google_analytics` application to your `INSTALLED_APPS` section of your `settings.py`.  This mode requires that you be using the Django sites framework too, so make sure you have that set up as well.
+2. Add `GOOGLE_ANALYTICS_MODEL = True` to your `settings.py` 
+3. Run a `./manage.py syncdb` to add the database tables
+4. Go to your project's admin page (usually `/admin/`) and click into a site objects
+5. You'll now see a new field under the normal site information called "Analytics Code". In this box you put your unique analytics code for your project's domain.  It looks like `UA-xxxxxx-x` and save the site.
+6. In your base template (usually a `base.html`) insert this tag at the very top: `{% load analytics %}`
+7. In the same template, insert the following code right before the closing body tag: `{% analytics %}`
+
+Just using the template tag
+===========================
+1. Add the `google_analytics` application to your `INSTALLED_APPS` section of your `settings.py`.
+2. In your base template, usually a `base.html`, insert this tag at the very top: `{% load analytics %}`
+3. In the same template, insert the following code right before the closing body tag: `{% analytics "UA-xxxxxx-x" %}` the `UA-xxxxxx-x` is a unique Google Analytics code for you domain when you sign up for a new account.
+
+### License ###
+
+The MIT License
+
+Copyright (c) 2009 Clint Ecker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/USAGE b/USAGE
deleted file mode 100644 (file)
index 4047438..0000000
--- a/USAGE
+++ /dev/null
@@ -1,51 +0,0 @@
-I manage a lot of Django projects that present slightly-different forms to 
-users depending on the site/domain they're visiting.  There's also a bunch of 
-custom submission code that differs from form to form, but that's neither here
-nor there.
-
-I need different Google Analytics codes depending on the sites and after 
-sticking these tags into every single template, I thought it would be cool to 
-be able to manage these Google analytics accounts from the Django admin page. 
-I also added a mode of operation that excludes the admin interface altogether 
-(you can just use the template tag)
-
-==Two modes of operation==
-
-Administering and associating codes with Django sites
----------------------------------------------------------
-1. Add the `google_analytics` application to your `INSTALLED_APPS` 
-               section of your `settings.py`.  This mode requires that you be using 
-               the Django sites framework too, so make sure you have that set up as 
-               well.
-
-2. Add `GOOGLE_ANALYTICS_MODEL = True` to your `settings.py` 
-
-3. Run a `./manage.py syncdb` to add the database tables
-
-4. Go to your project's admin page (usually `/admin/`) and click into a site 
-               objects
-
-5. You'll now see a new field under the normal site information called 
-               "Analytics Code". In this box you put your unique analytics code for 
-               your project's domain.  It looks like `UA-xxxxxx-x` and save the site.
-
-6. In your base template (usually a `base.html`) insert this tag at the very 
-               top: `{% load analytics %}`
-
-7. In the same template, insert the following code right before the closing 
-               body tag: `{% analytics %}`
-
-
-
-===Just using the template tag===
-
-1. Add the `google_analytics` application to your `INSTALLED_APPS` section of
-               your `settings.py`.
-
-2. In your base template, usually a `base.html`, insert this tag at the very 
-               top: `{% load analytics %}`
-
-3. In the same template, insert the following code right before the closing 
-               body tag: `{% analytics "UA-xxxxxx-x" %}` the `UA-xxxxxx-x` is a 
-               unique Google Analytics code for you domain when you sign up for a new
-               account.