Skip to content

Commit

Permalink
Doc updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ellmetha committed Mar 3, 2015
1 parent be33a56 commit cda1e41
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,33 @@
.. django-machina documentation master file, created by
sphinx-quickstart on Sun Mar 1 22:51:19 2015.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
##########################################
Welcome to django-machina's documentation!
==========================================
##########################################

.. image:: http://img.shields.io/travis/ellmetha/django-machina.svg?style=flat-square
:target: http://travis-ci.org/ellmetha/django-machina
:alt: Build status

.. image:: http://img.shields.io/coveralls/ellmetha/django-machina.svg?style=flat-square
:target: https://coveralls.io/r/ellmetha/django-machina
:alt: Coveralls status

|
*Django-machina* is a forum engine for Django providing a way to build community-driven websites. It offers a full-featured yet very extensible forum solution that is designed to be used inside existing Django applications.

*Django-machina* is customizable and extensible : each single functionality of the application can be customized or overriden to accommodate with your needs and your own business logic. The central aim of *django-machina* is to provide a solid core of a forum project - without much of extra functionality included - that can be extended or customized to suit your project needs.

Features
--------

* Forums tree management
* Per-forum permissions
* Topic and post editing
* Anonymous posting
* Pre-moderation
* Polls and attachments

Contents:
Using django-machina
--------------------

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit cda1e41

Please sign in to comment.