Adding readme in rst format

This commit is contained in:
Roman Mogilatov 2015-04-03 00:29:00 +03:00
parent 74bb47626d
commit 2880eaa727

67
README.rst Normal file
View File

@ -0,0 +1,67 @@
Objects
=======
Dependency management tool for Python projects.
+---------------------------------------+-------------------------------------------------------------------+
| *PyPi* | .. image:: https://pypip.in/version/Objects/badge.svg |
| | :target: https://pypi.python.org/pypi/Objects/ |
| | :alt: Latest Version |
| | .. image:: https://pypip.in/download/Objects/badge.svg |
| | :target: https://pypi.python.org/pypi/Objects/ |
| | :alt: Downloads |
| | .. image:: https://pypip.in/license/Objects/badge.svg |
| | :target: https://pypi.python.org/pypi/Objects/ |
| | :alt: License |
+---------------------------------------+-------------------------------------------------------------------+
| *Python versions and implementations* | .. image:: https://pypip.in/py_versions/Objects/badge.svg |
| | :target: https://pypi.python.org/pypi/Objects/ |
| | :alt: Supported Python versions |
| | .. image:: https://pypip.in/implementation/Objects/badge.svg |
| | :target: https://pypi.python.org/pypi/Objects/ |
| | :alt: Supported Python implementations |
+---------------------------------------+-------------------------------------------------------------------+
| *Builds and test coverage* | .. image:: https://travis-ci.org/rmk135/objects.svg?branch=master |
| | :target: https://travis-ci.org/rmk135/objects |
| | :alt: Build Status |
| | .. image:: https://coveralls.io/repos/rmk135/objects/badge.svg |
| | :target: https://coveralls.io/r/rmk135/objects |
| | :alt: Coverage Status |
+---------------------------------------+-------------------------------------------------------------------+
Introduction
------------
Python ecosystem consists of a big amount of various classes, functions and
objects that could be used for applications development. Each of them has its
own role.
Modern Python applications are mostly the composition of well-known open
source systems, frameworks, libraries and some turnkey functionality.
When application goes bigger, its amount of objects and their dependencies
also increased extremely fast and became hard to maintain.
**Objects** is designed to be developer's friendly tool for managing objects
and their dependencies in formal, pretty way. Main idea of **Objects** is to
keep dependencies under control.
Installation
------------
**Objects** library is available on PyPi_::
pip install objects
Documentation
-------------
**Objects** documentation is hosted on ReadTheDocs:
- `Stable version`_
- `Latest version`_
.. _PyPi: https://pypi.python.org/pypi/Objects
.. _Stable version: http://objects.readthedocs.org/en/stable/
.. _Latest version: http://objects.readthedocs.org/en/latest/