Skip to content

Commit 648340b

Browse files
authored
updating readme & adding changes for v3
1 parent 91510ec commit 648340b

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
OpenTok Python SDK
33
==================
44

5-
.. image:: https://travis-ci.org/opentok/Opentok-Python-SDK.svg
6-
:target: https://travis-ci.org/opentok/Opentok-Python-SDK
75
.. image:: https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg
86
:target: CODE_OF_CONDUCT.md
97

@@ -25,7 +23,7 @@ http://www.pip-installer.org/en/latest/
2523
Add the ``opentok`` package as a dependency in your project. The most common way is to add it to your
2624
``requirements.txt`` file::
2725

28-
opentok>=2.10.0
26+
opentok>=3.0
2927

3028
Next, install the dependencies::
3129

@@ -472,7 +470,7 @@ For more information about OpenTok live streaming broadcasts, see the
472470

473471

474472
Configuring Timeout
475-
-------
473+
-------------------
476474
Timeout is passed in the Client constructor:
477475

478476
``self.timeout = timeout``
@@ -529,6 +527,10 @@ This version of the SDK includes support for working with OpenTok archives.
529527

530528
The Client.create_session() method now includes a media_mode parameter, instead of a p2p parameter.
531529

530+
**Changes in v3.X.X:**
531+
532+
This version of the SDK includes significant improvements such as top level entity naming, where the Opentok class is now `Client`. We also implemented a standardised logging module, improved naming conventions and JWT generation to make developer experience more rewarding.
533+
532534
For details, see the reference documentation at
533535
http://www.tokbox.com/opentok/libraries/server/python/reference/index.html.
534536

0 commit comments

Comments
 (0)