From b33e915aa75ecf16a3e4e657dbdcd7e07447bca0 Mon Sep 17 00:00:00 2001 From: Vitaly Glibin Date: Fri, 15 Jan 2016 08:30:37 +0300 Subject: [PATCH] add docs --- README.rst | 8 +++++--- docs/index.rst | 15 +++++++++++---- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 6b383f8..d241fe9 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Tortik ================== -Tortik is a micro framework atop of Python Tornado making easier to develop SOA-based applications. +Tortik is a frontend micro framework atop of Python Tornado making easier to develop SOA-based applications. .. image:: https://travis-ci.org/glibin/tortik.svg :target: https://travis-ci.org/glibin/tortik @@ -16,7 +16,9 @@ Tortik is a micro framework atop of Python Tornado making easier to develop SOA- :target: https://pypi.python.org/pypi/tortik -Documentation available at ``_ +Short explanation of tortik features: ``_ +Documentation and installation instructions ``_ -Explanation of SOA and tortik use cases at PyCon RU 2014 (in Russian) ``_ + +SOA (microservices) and tortik use cases at PyCon RU 2014 (in Russian) ``_ diff --git a/docs/index.rst b/docs/index.rst index 855eef1..c249369 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,13 +8,16 @@ :width: 427 -Tortik is a micro framework atop of Python Tornado making easier to develop SOA-based applications. +Tortik is a frontend micro framework atop of Python Tornado making easier to develop SOA-based applications. -Documentation available at ``_ +Short explanation of tortik features: ``_ +Documentation and installation instructions ``_ + + +SOA (microservices) and tortik use cases at PyCon RU 2014 (in Russian) ``_ -Explanation of SOA and tortik use cases at PyCon RU 2014 (in Russian) ``_ Installation @@ -24,9 +27,13 @@ Installation pip install tortik -Tortik is listed in `PyPI `_ and +Tortik is listed in `PyPI`_ and can be installed with ``pip`` or ``easy_install``. +If you plan to use XML backends it's highly recommended to install `lxml`_ +package (tortik will use it if available) which is much faster than native implementation +and have more features and additional libraries. + Documentation -------------