Merge pull request #251 from MichaelJolley/master

Updating repo to adhere to Vonage repo-standards

Author: dragonmantank

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

README.md

@@ -1,11 +1,13 @@
 # OpenTok PHP SDK
 
-[![Build Status](https://travis-ci.org/opentok/OpenTok-PHP-SDK.svg)](https://travis-ci.org/opentok/OpenTok-PHP-SDK)
+[![Build Status](https://travis-ci.org/opentok/OpenTok-PHP-SDK.svg)](https://travis-ci.org/opentok/OpenTok-PHP-SDK) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
+
+<img src="https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg" height="48px" alt="Tokbox is now known as Vonage" />
 
 The OpenTok PHP SDK lets you generate [sessions](http://tokbox.com/developer/guides/create-session/) and
 [tokens](http://tokbox.com/developer/guides/create-token/) for [OpenTok](http://www.tokbox.com/)
 applications, and [archive](http://tokbox.com/developer/guides/archiving/) sessions.
-It also includes  methods for working with OpenTok
+It also includes methods for working with OpenTok
 [archives](http://tokbox.com/developer/guides/archiving), working with OpenTok
 [SIP interconnect](http://tokbox.com/developer/guides/sip), and
 [disconnecting clients from sessions](http://tokbox.com/developer/guides/moderation/rest/).
@@ -56,12 +58,12 @@ $opentok = new OpenTok($apiKey, $apiSecret);
 To create an OpenTok Session, use the `createSession($options)` method of the
 `OpenTok\OpenTok` class. The `$options` parameter is an optional array used to specify the following:
 
-* Setting whether the session will use the OpenTok Media Router or attempt to send streams directly
+- Setting whether the session will use the OpenTok Media Router or attempt to send streams directly
   between clients.
 
-* Setting whether the session will automatically create archives (implies use of routed session)
+- Setting whether the session will automatically create archives (implies use of routed session)
 
-* Specifying a location hint.
+- Specifying a location hint.
 
 The `getSessionId()` method of the `OpenTok\Session` instance returns the session ID,
 which you use to identify the session in the OpenTok client libraries.
@@ -97,7 +99,7 @@ Once a Session is created, you can start generating Tokens for clients to use wh
 You can generate a token either by calling the `generateToken($sessionId, $options)` method of the
 `OpenTok\OpenTok` class, or by calling the `generateToken($options)` method on the `OpenTok\Session`
 instance after creating it. The `$options` parameter is an optional array used to set the role,
-expire time, and connection data of the Token. For layout control in archives and broadcasts, 
+expire time, and connection data of the Token. For layout control in archives and broadcasts,
 the initial layout class list of streams published from connections using this token can be set as well.
 
 ```php
@@ -302,8 +304,9 @@ use OpenTok\OpenTok;
 $layout Layout::getPIP(); // Or use another get method of the Layout class.
 $opentok->updateBroadcastLayout($broadcastId, $layout);
 ```
+
 You can use the `Layout` class to set the layout types:
-`Layout::getHorizontalPresentation()`, `Layout::getVerticalPresentation()`,  `Layout::getPIP()`,
+`Layout::getHorizontalPresentation()`, `Layout::getVerticalPresentation()`, `Layout::getPIP()`,
 `Layout::getBestFit()`, `Layout::createCustom()`.
 
 ```php
@@ -334,7 +337,7 @@ developer guide.
 
 ### Force a Client to Disconnect
 
-Your application server can disconnect a client from an OpenTok session by calling the `forceDisconnect($sessionId, $connectionId)` 
+Your application server can disconnect a client from an OpenTok session by calling the `forceDisconnect($sessionId, $connectionId)`
 method of the `OpenTok\OpenTok` class.
 
 ```php
@@ -343,6 +346,7 @@ use OpenTok\OpenTok;
 // Force disconnect a client connection
 $opentok->forceDisconnect($sessionId, $connectionId);
 ```
+
 ### Sending Signals
 
 Once a Session is created, you can send signals to everyone in the session or to a specific connection.
@@ -354,15 +358,14 @@ The `$sessionId` parameter is the session ID of the session.
 The `$payload` parameter is an associative array used to set the
 following:
 
-* `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
+- `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
 
-* `type` (string) -- &mdash; (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '_', and '~'.
+- `type` (string) -- &mdash; (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '\_', and '~'.
 
 The `$connectionId` parameter is an optional string used to specify the connection ID of
 a client connected to the session. If you specify this value, the signal is sent to
 the specified client. Otherwise, the signal is sent to all clients connected to the session.
 
-
 ```php
 use OpenTok\OpenTok;
 
@@ -417,7 +420,7 @@ guide](https://tokbox.com/developer/guides/sip/).
 
 ## Force Disconnect
 
-Your application server can disconnect a client from an OpenTok session by calling the `forceDisconnect($sessionId, $connectionId)` 
+Your application server can disconnect a client from an OpenTok session by calling the `forceDisconnect($sessionId, $connectionId)`
 method of the `OpenTok\OpenTok` class.
 
 ```php
@@ -426,6 +429,7 @@ use OpenTok\OpenTok;
 // Force disconnect a client connection
 $opentok->forceDisconnect($sessionId, $connectionId);
 ```
+
 ## Sending Signals
 
 Once a Session is created, you can send signals to everyone in the session or to a specific connection.
@@ -437,15 +441,14 @@ The `$sessionId` parameter is the session ID of the session.
 The `$payload` parameter is an associative array used to set the
 following:
 
-* `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
+- `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
 
-* `type` (string) -- &mdash; (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '_', and '~'.
+- `type` (string) -- &mdash; (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '\_', and '~'.
 
 The `$connectionId` parameter is an optional string used to specify the connection ID of
 a client connected to the session. If you specify this value, the signal is sent to
 the specified client. Otherwise, the signal is sent to all clients connected to the session.
 
-
 ```php
 use OpenTok\OpenTok;
 
@@ -473,9 +476,9 @@ guide](https://tokbox.com/developer/guides/signaling/).
 There are three sample applications included in this repository. To get going as fast as possible, clone the whole
 repository and follow the Walkthroughs:
 
-*  [HelloWorld](sample/HelloWorld/README.md)
-*  [Archiving](sample/Archiving/README.md)
-*  [SipCall](sample/SipCall/README.md)
+- [HelloWorld](sample/HelloWorld/README.md)
+- [Archiving](sample/Archiving/README.md)
+- [SipCall](sample/SipCall/README.md)
 
 ## Documentation
 
@@ -513,8 +516,8 @@ This version of the SDK includes support for working with OpenTok archives.
 The names of many methods of the API have changed. Many method names have
 changed to use camel case, including the following:
 
-* `\OpenTok\OpenTok->createSession()`
-* `\OpenTok\OpenTok->generateToken()`
+- `\OpenTok\OpenTok->createSession()`
+- `\OpenTok\OpenTok->generateToken()`
 
 Note also that the `options` parameter of the `OpenTok->createSession()` method has a `mediaMode`
 property instead of a `p2p` property.
@@ -530,9 +533,11 @@ docs directory of the SDK.
 Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and
 [Contribution](CONTRIBUTING.md) guidelines.
 
-## Support
+## Getting Help
 
-See <https://support.tokbox.com> for all our support options.
+We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:
 
-Find a bug? File it on the [Issues](https://github.com/opentok/opentok-php-sdk/issues) page. Hint:
-test cases are really helpful!
+- Open an issue on this repository
+- See <https://support.tokbox.com/> for support options
+- Tweet at us! We're [@VonageDev on Twitter](https://twitter.com/VonageDev)
+- Or [join the Vonage Developer Community Slack](https://developer.nexmo.com/community/slack)