nikdoof/django-eveigb
1
0
Fork 0
mirror of https://github.com/nikdoof/django-eveigb.git synced 2025-12-17 11:39:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added basic README

Browse Source
This commit is contained in:
Andrew Williams
2012-03-03 15:39:51 +00:00
parent 8042a33a8e
commit b3497e8bb4
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md Normal file
View File

@@ -0,0 +1,22 @@
Django-EVEIGB
=============
This library/application allows you to make use of EVE's in-game browser and most of the features available within it.
Installation
------------
1. Install the package with setup.py
2. Add 'eveigb' to your INSTALLED_APPS in your settings.py
3. Add eveigb.middleware.IGBMiddleware to MIDDLEWARE_CLASSES
4. Add eveigb.context_processors.igb to TEMPLATE_CONTEXT_PROCESSORS if you wish to make use of the template variables
Usage
-----
The context processor makes a few variables available in your templates:
* is_igb - Indicates if the client is a EVE IGB client
* is_igb_trusted - Indicates if the client has trusted the site