Permalink
Browse files

Updated readme with parameter details.

  • Loading branch information...
1 parent 22ee26b commit cef8bcda525c483bd7d654085c7487879112a503 @bertjohnson committed Oct 31, 2015
Showing with 7 additions and 0 deletions.
  1. +7 −0 README.md
View
@@ -15,6 +15,13 @@ To add your Twitch stream, use the following code:
[twitch channel="twitchchannelname" height="640" height="480"]
+The following shortode parameters are supported:
+
+1. **channel**: Name of the Twich user / channel
+2. **height**: Height of the stream (e.g., `400px`, `100%`, `2em`)
+2. **width**: Width of the stream (e.g., `600px`, `100%`, `2em`)
+3. **https**: `yes` or `no`. By default, content is served over HTTP via Twitch's HTML5 player. If `yes` is specified, content is delivered via a legacy Flash player seved via Justin.TV's CDN (https://www-cdn.jtvnw.net/swflibs/TwitchPlayer.rfc07d37fc4eed1d17243b452dd3441665496e1e0.swf?channel={$channel}).
+
License
=======

0 comments on commit cef8bcd

Please sign in to comment.