Updating repo to use repo-standards

michaeljolley · michaeljolley · commit 6d0fc2ff8d0b · 2020-04-03T18:14:55.000-05:00
diff --git a/CODE_OF_CONDUCT.md b/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
+devrel@vonage.com.
+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.
diff --git a/README.md b/README.md
@@ -1,33 +1,34 @@
 # OpenTok .NET SDK
 
-[![Build status](https://ci.appveyor.com/api/projects/status/tw2d8ufd3tpwkf5b?svg=true)](https://ci.appveyor.com/project/aoberoi/opentok-net-sdk)  [![Build Status](https://travis-ci.org/opentok/Opentok-.NET-SDK.svg)](https://travis-ci.org/opentok/Opentok-.NET-SDK)
+![https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg](https://assets.tokbox.com/img/vonage/Vonage_VideoAPI_black.svg)
 
+[![Build status](https://ci.appveyor.com/api/projects/status/tw2d8ufd3tpwkf5b?svg=true)](https://ci.appveyor.com/project/aoberoi/opentok-net-sdk) [![Build Status](https://travis-ci.org/opentok/Opentok-.NET-SDK.svg)](https://travis-ci.org/opentok/Opentok-.NET-SDK)
 
 The OpenTok .NET SDK lets you generate
 [sessions](https://www.tokbox.com/opentok/tutorials/create-session/) and
 [tokens](https://www.tokbox.com/opentok/tutorials/create-token/) for
 [OpenTok](https://www.tokbox.com/) applications that run on the .NET platform. The SDK also includes
 support for working with [OpenTok archives](https://tokbox.com/opentok/tutorials/archiving).
 
-# Installation
+## Installation
 
-## NuGet (recommended):
+### NuGet (recommended):
 
 Using the [Package Manager Console](http://docs.nuget.org/consume/package-manager-console):
 
 ```
 PM> Install-Package OpenTok
 ```
 
-## Manually:
+### Manually:
 
 Download the latest release from the [Releases Page](https://github.com/opentok/Opentok-.NET-SDK/releases).
 Unzip the file and place the place the `OpenTok.dll`, dependent assemblies, and supporting files into your
 own project.
 
-# Usage
+## Usage
 
-## Initializing
+### Initializing
 
 Import the `OpenTokSDK` namespace into any files that will be using OpenTok objects. Then initialize an
 `OpenTokSDK.OpenTok` object using your own API Key and API Secret.
@@ -42,19 +43,19 @@ string ApiSecret = "YOUR API SECRET";
 var OpenTok = new OpenTok(ApiKey, ApiSecret);
 ```
 
-## Creating Sessions
+### Creating Sessions
 
 To create an OpenTok Session, call the `OpenTok` instance's
 `CreateSession(string location, MediaMode mediaMode, ArchiveMode archiveMode)`
 method. Each of the parameters are optional and can be omitted if not needed. They are:
 
-* `string location` : An IPv4 address used as a location hint. (default: "")
+- `string location` : An IPv4 address used as a location hint. (default: "")
 
-* `MediaMode mediaMode` : Specifies whether the session will use the OpenTok Media Router
-   (MediaMode.ROUTED) or attempt to transmit streams directly between clients
-   (MediaMode.RELAYED, the default)
+- `MediaMode mediaMode` : Specifies whether the session will use the OpenTok Media Router
+  (MediaMode.ROUTED) or attempt to transmit streams directly between clients
+  (MediaMode.RELAYED, the default)
 
-* `ArchiveMode archiveMode` : Specifies whether the session will be automatically archived
+- `ArchiveMode archiveMode` : Specifies whether the session will be automatically archived
   (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL, the default)
 
 The return value is a `OpenTokSDK.Session` object. Its `Id` property is useful to get an identifier that can be saved to a
@@ -77,7 +78,7 @@ var session = OpenTok.CreateSession(mediaMode: MediaMode.ROUTED, ArchiveMode.ALW
 string sessionId = session.Id;
 ```
 
-## Generating Tokens
+### Generating Tokens
 
 Once a Session is created, you can start generating Tokens for clients to use when connecting to it.
 You can generate a token either by calling an `OpenTokSDK.OpenTok` instance's
@@ -99,7 +100,7 @@ string token = session.GenerateToken(role: Role.MODERATOR, expireTime: inOneWeek
 
 ```
 
-## Working with Archives
+### Working with Archives
 
 You can start the recording of an OpenTok Session using a `OpenTokSDK.OpenTok` instance's
 `StartArchive(sessionId, name, hasVideo, hasAudio, outputMode, resolution)` method. This will return an
@@ -113,6 +114,7 @@ var archive = OpenTok.StartArchive(sessionId);
 // Store this archive ID in the database for later use
 Guid archiveId = archive.Id;
 ```
+
 You can add a name for the archive (to use for identification) by setting the `name` parameter of
 the `OpenTok.StartArchive()` method.
 
@@ -172,7 +174,7 @@ Note that you can also create an automatically archived session, by passing in `
 as the `archiveMode` parameter when you call the `OpenTok.CreateSession()` method (see "Creating
 Sessions," above).
 
-## Working with Streams
+### Working with Streams
 
 You can get information about a stream by calling the `GetStream(sessionId, streamId)` method of the `OpenTok` class.
 
@@ -188,29 +190,31 @@ stream.LayoutClassList; // list with the layout class list
 
 You can get information about all the streams in a session by calling the `ListStreams(sessionId)` method of the `OpenTok` class.
 
-
 ```csharp
 StreamList streamList = OpenTok.ListStreams(sessionId);
 
-streamList.Count; // total count 
+streamList.Count; // total count
 ```
 
-## Force Disconnecting
+### Force Disconnecting
 
 Your application server can disconnect a client from an OpenTok session by calling the `ForceDisconnect(sessionId, connectionId)` method of the `OpenTok` class.
 
 ```csharp
 // Force disconnect a client connection
 OpenTok.ForceDisconnect(sessionId, connectionId);
 ```
-## Sending Signals
+
+### Sending Signals
+
 Once a Session is created, you can send signals to everyone in the session or to a specific connection. You can send a signal by calling the `Signal(sessionId, signalProperties, connectionId)` method of the `OpenTok` class.
 
 The `sessionId` parameter is the session ID of the session.
 
 The `signalProperties` parameter is an instance of the `SignalProperties` class where you can set the `data` paramter and the `type` parameter.
-* `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
-* `type` (string) -- (Optional) The type string for the signal. You can send a maximum of 128 charaacters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '_', and '~'.
+
+- `data` (string) -- The data string for the signal. You can send a maximum of 8kB.
+- `type` (string) -- (Optional) The type string for the signal. You can send a maximum of 128 charaacters, 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 conencted 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.
 
@@ -223,35 +227,37 @@ string connectionId = "CONNECTIONID";
 OpenTok.Signal(sessionId, signalProperties, connectionId);
 ```
 
-# Samples
+## Samples
 
 There are two sample applications included with the SDK. To get going as fast as possible, clone the whole
 repository and follow the Walkthroughs:
 
-*  [HelloWorld](Samples/HelloWorld/README.md)
-*  [Archiving](Samples/Archiving/README.md)
+- [HelloWorld](Samples/HelloWorld/README.md)
+- [Archiving](Samples/Archiving/README.md)
 
-# Documentation
+## Documentation
 
 Reference documentation is available at <https://tokbox.com/developer/sdks/dot-net/reference/>.
 
-# Requirements
+## Requirements
 
 You need an OpenTok API key and API secret, which you can obtain by logging into your
 [TokBox account](https://tokbox.com/account).
 
 The OpenTok .NET SDK requires .NET Framework 4.5.2 or greater.
+
 > NOTE: When using on 4.5.2 TLS 1.2 is not enabled by default. You should use something like the following to force the runtime onto at least TLS 1.2
+
 ```
 ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls12;
 ```
 
-# Release Notes
+## Release Notes
 
 See the [Releases](https://github.com/opentok/opentok-.net-sdk/releases) page for details
 about each release.
 
-## Important changes since v2.2.0
+### Important changes since v2.2.0
 
 **Changes in v3.0.0:**
 
@@ -272,11 +278,11 @@ This version of the SDK includes support for working with OpenTok archives.
 This version of the SDK includes a number of improvements in the API design. These include a number
 of API changes:
 
-* New OpenTok class --  The name of the main class has changed from OpenTokSDK to OpenTok.
+- New OpenTok class -- The name of the main class has changed from OpenTokSDK to OpenTok.
   In the previous version, the constructor was `OpenTokSDK()`.
   In v2.2, it is `OpenTok(int apiKey, int apiSecret)`.
 
-* CreateSession -- In the previous version, there were two methods to create a session:
+- CreateSession -- In the previous version, there were two methods to create a session:
   `OpenTokSDK.CreateSession(String location)` and
   `OpenTokSDK.CreateSession(String location, Dictionary<string, object> options)`.
   These methods returned a string (the session ID).
@@ -285,25 +291,31 @@ of API changes:
   `CreateSession(string location = "", MediaMode mediaMode = MediaMode.ROUTED)`.
   The `mediaMode` parameter replaces the `p2p.preference` setting in the
   previous version. The method returns a Session Object.
-  
-* GenerateToken -- In the previous version, there were two methods:
+
+- GenerateToken -- In the previous version, there were two methods:
   `OpenTokSDK.GenerateToken(string sessionId)` and
   `OpenTokSDK.GenerateToken(string sessionId, Dictionary<string, object> options)`
   In v2.2, this is replaced with the following method:
   `OpenTokSDK.OpenTok.GenerateToken(string sessionId, Role role = Role.PUBLISHER, double expireTime = 0, string data = null)`.
   All parameters, except the `sessionId` parameter, are optional.
-  
+
   Also, the Session class includes a method for generating tokens:
   `OpenTokSDK.Session.GenerateToken(Role role = Role.PUBLISHER, double expireTime = 0, string data = null)`.
 
-# Development and Contributing
+## Development and Contributing
 
 Interested in contributing? We :heart: pull requests! See the [Development](DEVELOPING.md) and
 [Contribution](CONTRIBUTING.md) guidelines.
 
-# Support
+## Getting Help
+
+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:
+
+- 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)
 
-See <https://support.tokbox.com/> for all our support options.
+## Further Reading
 
-Find a bug? File it on the [Issues](https://github.com/opentok/opentok-.net-sdk/issues) page. Hint:
-test cases are really helpful!
+- Check out the Developer Documentation at <https://tokbox.com/developer/>
