.. Burst documentation master file, created by
   sphinx-quickstart on Sat Jan 28 07:08:14 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Burst's documentation!
=================================

A burst of providers.

Features
--------
- Fast, very fast
- Compatible with Magnetic/Magnetizer, but **disable the Quasar Connector**
- Can extract providers, parsers and settings from Magnetic
- No extra add-ons to install, all providers are included
- No extra service running in the background
- Easy settings to enable or disable providers and filters
- First-class support with Quasar, and only Quasar (don't even ask)
- Simple definitions-based architecture with overrides
- Clean, PEP8 compliant code

Installation
------------

**IMPORTANT: Disable the Magnetic Quasar Connector before anything else.**

Get the latest release from https://burst.surge.sh and *Install from zip*
within Kodi, or install the add-on from the Quasar Repository if you already
have Quasar installed.

Topics
------

.. toctree::
   :maxdepth: 2

   using_filters
   using_overrides
   adding_providers
   source/burst

* :ref:`modindex`

Credits
-------
- @mancuniancol for all his work on Magnetic, this add-on wouldn't have been
  possible without him.
- All the alpha and beta testers that led to the first stable release.
