mirror of
https://github.com/nikdoof/django-eveigb.git
synced 2025-12-13 11:42:16 +00:00
Added basic README
This commit is contained in:
22
README.md
Normal file
22
README.md
Normal 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
|
||||
Reference in New Issue
Block a user