Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent cd293e7 commit 0ebdd9cd47139b50269c5f35f282b81f0ce18aec @bertjohnson committed Oct 25, 2015
Showing with 38 additions and 1 deletion.
  1. +38 −1 README.md
View
@@ -1,2 +1,39 @@
-# WP-Twitch
+=== Plugin Name ===
+Contributors: bertjohnson)
+Donate link: https://bertjohnson.com
+Tags: twitch, video, embed
+Requires at least: 2.0
+Tested up to: 4.4
+Stable tag: trunk
+License: MIT
+License URI: http://mit-license.org/
+
Simple embedding of your Twitch stream, which will only show when you're online.
+
+== Description ==
+
+Simple embedding of your Twitch stream, which will only show when you're online.
+
+== Installation ==
+
+1. Download and unzip the file.
+2. Place the entire contents of the directory into your `/wp-content/plugins/` directory.
+3. Activate the plugin through the 'Plugins' menu in WordPress.
+
+== Screenshots ==
+
+== Shortcode Usage ==
+
+To add your Twitch stream, use the following code:
+
+ [twitch channel="twitchchannelname" height="640" height="480"]
+
+Options are:
+1. channel: Twitch channel name
+2. width: Width of the video player
+3. height: Height of the video player
+4. https: "true" if the channel needs to be served over SSL
+
+== Changelog ==
+= 1.0 =
+Initial release.

0 comments on commit 0ebdd9c

Please sign in to comment.