Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
glibin committed Jan 15, 2016
1 parent 3ef1fc9 commit b33e915
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
8 changes: 5 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 `<http://glibin.github.io/tortik>`_
Short explanation of tortik features: `<http://glibin.github.io/tortik>`_

Documentation and installation instructions `<http://tortik.readthedocs.org/en/latest/>`_

Explanation of SOA and tortik use cases at PyCon RU 2014 (in Russian) `<http://glibin.github.io/lections/pycon2014/>`_

SOA (microservices) and tortik use cases at PyCon RU 2014 (in Russian) `<http://glibin.github.io/lections/pycon2014/>`_
15 changes: 11 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 `<http://glibin.github.io/tortik>`_
Short explanation of tortik features: `<http://glibin.github.io/tortik>`_

Documentation and installation instructions `<http://tortik.readthedocs.org/en/latest/>`_


SOA (microservices) and tortik use cases at PyCon RU 2014 (in Russian) `<http://glibin.github.io/lections/pycon2014/>`_

Explanation of SOA and tortik use cases at PyCon RU 2014 (in Russian) `<http://glibin.github.io/lections/pycon2014/>`_


Installation
Expand All @@ -24,9 +27,13 @@ Installation

pip install tortik

Tortik is listed in `PyPI <http://pypi.python.org/pypi/tortik>`_ and
Tortik is listed in `PyPI<http://pypi.python.org/pypi/tortik>`_ and
can be installed with ``pip`` or ``easy_install``.

If you plan to use XML backends it's highly recommended to install `lxml<http://lxml.de/>`_
package (tortik will use it if available) which is much faster than native implementation
and have more features and additional libraries.


Documentation
-------------
Expand Down

0 comments on commit b33e915

Please sign in to comment.