.. Django Channels IRC documentation master file, created by
   sphinx-quickstart on Mon Aug 13 15:17:15 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

===============================================
Welcome to Django Channels IRC's documentation!
===============================================

**Django Channels IRC** is a bridge between IRC and Django's ``channels``. 
It contains both a new interface server for connecting to IRC and Channels
consumers -- everything you need to turn your Django app into an IRC chatbot,
chat monitoring/moderating service, or whatever else you might use a real-time
IRC client to do.

Installation
============

Install the package from pip::

    pip install channels-irc

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   basic-usage
   command-line
   irc-consumer