README.md

   1 License
   2 -------
   3
   4   ![AGPL Logo](http://www.gnu.org/graphics/agplv3-155x51.png)
   5
   6     Copyright © 2014 Fundacja Nowoczesna Polska <fundacja@nowoczesnapolska.org.pl>
   7
   8     For full list of contributors see AUTHORS section at the end.
   9
  10     This program is free software: you can redistribute it and/or modify
  11     it under the terms of the GNU Affero General Public License as published by
  12     the Free Software Foundation, either version 3 of the License, or
  13     (at your option) any later version.
  14
  15     This program is distributed in the hope that it will be useful,
  16     but WITHOUT ANY WARRANTY; without even the implied warranty of
  17     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18     GNU Affero General Public License for more details.
  19
  20     You should have received a copy of the GNU Affero General Public License
  21     along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22
  23
  24 Dependencies
  25 ============
  26
  27  * Python >= 2.7
  28  * Django >= 1.6
  29
  30
  31 Installation
  32 ============
  33
  34 1. Add 'ssify' to INSTALLES_APPS.
  35 2. Add middleware classes:
  36    * ssify.middleware.SsifyMiddleware on top,
  37    * if using UpdateCacheMiddleware, add
  38      ssify.middleware.PrepareForCacheMiddleware after it,
  39    * ssify.middleware.LocaleMiddleware instead of stock LocaleMiddleware.
  40 3. Make sure you have 'django.core.context_processors.request' in your
  41    TEMPLATE_CONTEXT_PROCESSORS.
  42 3. Define your caches in CACHES and SSIFY_INCLUDES_CACHES
  43    for storing ssi includes.
  44 4. Configure your webserver to use SSI ('ssi=on' with Nginx).
  45
  46 Usage
  47 =====
  48
  49 1. Define your included urls using the @ssi_included decorator.
  50 2. Define your ssi variables using the @ssi_variable decorator.
  51
  52
  53 Authors
  54 =======
  55
  56 * Radek Czajka <radekczajka@nowoczesnapolska.org.pl>
  57