Skip to content

Commit a2892a3

Browse files
readme: consistency with doc
Make README consistent with documentation index page. Remove Tarantool 1.6 guides since the version was deprecated several years ago. Part of #67
1 parent 14b728b commit a2892a3

File tree

1 file changed

+13
-18
lines changed

1 file changed

+13
-18
lines changed

Diff for: README.rst

+13-18
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,16 @@ With pip (recommended)
2222

2323
The recommended way to install the ``tarantool`` package is using ``pip``.
2424

25-
For Tarantool version < 1.6.0, get the ``0.3.*`` connector version::
26-
27-
$ pip install tarantool\<0.4
28-
29-
For a later Tarantool version, get the ``0.5.*`` connector version::
25+
.. code-block:: bash
3026
31-
$ pip install tarantool\>0.4
27+
$ pip install tarantool
3228
3329
ZIP archive
3430
^^^^^^^^^^^
3531

36-
You can also download zip archive, unpack it and run::
32+
You can also download zip archive, unpack it and run:
33+
34+
.. code-block:: bash
3735
3836
$ python setup.py install
3937
@@ -42,11 +40,7 @@ Development version
4240

4341
You can also install the development version of the package using ``pip``.
4442

45-
For Tarantool version < 1.6.0, get the ``stable`` branch::
46-
47-
$ pip install git+https://github.com/tarantool/tarantool-python.git@stable
48-
49-
For a later Tarantool version, use the ``master`` branch::
43+
.. code-block:: bash
5044
5145
$ pip install git+https://github.com/tarantool/tarantool-python.git@master
5246
@@ -55,17 +49,15 @@ For a later Tarantool version, use the ``master`` branch::
5549
What is Tarantool?
5650
------------------
5751

58-
`Tarantool`_ is an in-memory NoSQL database with a Lua application server on board.
59-
It combines the network programming power of Node.JS
60-
with data persistency capabilities of Redis.
61-
It's open-source, licensed under `BSD-2-Clause`_.
52+
`Tarantool`_ is an in-memory computing platform originally designed by
53+
`VK`_ and released under the terms of `BSD license`_.
6254

6355
Features
6456
--------
6557

6658
* ANSI SQL, including views, joins, referential and check constraints
6759
* Lua packages for non-blocking I/O, fibers, and HTTP
68-
* MsgPack data format and MsgPack-based client-server protocol
60+
* MessagePack data format and MessagePack-based client-server protocol
6961
* Two data engines:
7062

7163
* memtx – in-memory storage engine with optional persistence
@@ -97,7 +89,7 @@ Run tests
9789

9890
On Linux:
9991

100-
.. code-block:: console
92+
.. code-block:: bash
10193
10294
$ python setup.py test
10395
@@ -141,7 +133,10 @@ Open ``localhost:8000`` in your browser to read the docs.
141133
.. _`Tarantool homepage`: https://tarantool.io
142134
.. _`Tarantool on GitHub`: https://github.com/tarantool/tarantool
143135
.. _`Tarantool documentation`: https://www.tarantool.io/en/doc/latest/
136+
.. _`VK`: https://vk.company
144137
.. _`Client-server protocol specification`: https://www.tarantool.io/en/doc/latest/dev_guide/internals/box_protocol/
138+
.. _`BSD`:
139+
.. _`BSD license`:
145140
.. _`BSD-2-Clause`: https://opensource.org/licenses/BSD-2-Clause
146141
.. _`asynctnt`: https://github.com/igorcoding/asynctnt
147142
.. _`feature comparison table`: https://www.tarantool.io/en/doc/latest/book/connectors/#python-feature-comparison

0 commit comments

Comments
 (0)