diff --git a/docs/index.rst b/docs/index.rst index ba051cc1..12180f00 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,55 @@ Python Cassandra Driver ======================= +A Python client driver for `Apache Cassandra `_. +This driver works exclusively with the Cassandra Query Language v3 (CQL3) +and Cassandra's native protocol. Cassandra 1.2+ is supported. + +The driver supports Python 2.6, 2.7, 3.3, and 3.4. + +This driver is open source under the +`Apache v2 License `_. +The source code for this driver can be found on `Github `_. + +Contents +-------- +:doc:`installation` + How to install the driver. + +:doc:`getting_started` + A guide through the first steps of connecting to Cassandra and executing queries. + +:doc:`api/index` + The API documentation. + +:doc:`upgrading` + A guide to upgrading versions of the driver. + +:doc:`performance` + Tips for getting good performance. + +:doc:`query_paging` + Notes on paging large query results. + +:doc:`security` + An overview of the security features of the driver. + +Getting Help +------------ +Please send questions to the `mailing list `_. + +Alternatively, you can use IRC. Connect to the #datastax-drivers channel on irc.freenode.net. +If you don't have an IRC client, you can use `freenode's web-based client `_. + +Reporting Issues +---------------- +Please report any bugs and make any feature requests on the +`JIRA `_ issue tracker. + +If you would like to contribute, please feel free to open a pull request. + .. toctree:: - :maxdepth: 2 + :hidden: api/index installation