WordPress.org
Get WordPress

Plugin Directory

Changeset 704106


Ignore:
Timestamp:
04/26/2013 10:46:43 AM (13 years ago)
Author:
tkrivickas
Message:

Updated README with Description/Quickstart sections

File:
1 edited

Legend:

Unmodified
Added
Removed

  • live-stream-badger/trunk/readme.txt

    r700755 r704106  
    88License URI: http://www.gnu.org/licenses/gpl-2.0.html
    99
    10 Display status of Twitch.tv live streams
     10Display status of Twitch.tv livestreams
    1111
    1212== Description ==
    1313
    14 Simple Widget to display status of a Live Stream (Twitch.tv) on your website.
     14All-in-one livestream (Twitch.TV) integration for your WordPress website.
    1515
    1616= Features =
    17 * Shortcode support (you can add flags, see `F.A.Q`)
     17* Widget to display livestream status (Online/Offline)
     18* Shortcode to embed a livestream: `[livestream url="http://www.twitch.tv/mychannel"]`
    1819
    19 Suggest new ideas and report issues in [Support section](http://wordpress.org/support/plugin/live-stream-badger)!
     20= Planned features (to do) =
     21* TinyMCE extension for user-friendly embedding of a livestream via shortcode
     22* Thumbnails instead of simple links in the Widget
     23* Top livestreams listed by category as a Widget
     24* Support multiple livestream providers (e.g. Hashd.TV, Justin.TV, UStream.TV)
    2025
    21 Feedback is appreciated!
     26= Have something to say? =
     27[Suggest ideas, report issues or join development](http://wordpress.org/support/plugin/live-stream-badger)!
    2228
    2329== Installation ==
    2430
    25 1. Download and unzip the plugin into your WordPress plugins directory (usually `/wp-content/plugins/`).
    26 2. Activate the plugin through the 'Plugins' menu in WordPress.
    27 3. Using WordPress Appearance > Menus, create a menu with Custom Links to Live Stream channels (e.g. `http://www.twitch.tv/tobiwandota` as URL and `My favourite stream!` as a label).
    28 4. Place the widget on your sidebar through the 'Widgets' menu in your WordPress Admin.
    29 5. When configuring the widget, select a menu that contains your precious Live Stream links.
     311. Upload the `live-stream-badger` folder to the `/wp-content/plugins/` directory
     322. Activate the Live Stream Badger through the 'Plugins' menu in WordPress
     333. Done! Follow [Quickstart](http://wordpress.org/extend/plugins/live-stream-badger/quickstart/)
     34
     35== Quickstart ==
     36
     37= Configure 'Stream status' widget =
     38
     391. Go to WordPress Appearance > Menus
     402. Create a new menu
     413. Create a custom link, add it to the menu and save. Link should point to the channel, e.g. `http://www.twitch.tv/tobiwandota` as URL and `My favourite stream!` as a label
     424. Go to Wordpress Appearance > Widgets
     435. Place 'LSB Stream Status' widget on the sidebar
     446. In widget configuration, select the menu you created in Step (3) and save
     457. Go to your website and you should see the livestream link in a widget
     468. Wait for about 5 minutes (stream status is updating) and refresh the page
     479. You should see a livestream link and its status (how many viewers are watching or 'Offline')
     48
     49= Embed a stream using the shortcode =
     50
     511. Create new or edit a post
     522. Type in the following: `[livestream url="http://www.twitch.tv/tobiwandota"]`
     533. Save and view the post
     544. You should see an embedded livestream in the post
    3055
    3156== Frequently Asked Questions ==
    3257
    33 = Which live stream websites are supported? =
    34 
    35 Currently, only [Twitch.tv](http://www.twitch.tv) is supported.
    36 Other platforms will be supported in the future versions.
    37 
    38 = How do I add Live Stream links? =
    39 
    40 Using 'Appearance' > 'Menus' in WordPress Admin:
    41  
    42 1. Create a menu (you can name it 'Streams').
    43 2. Add Custom Links to this menu
    44 
    45 = How to add a flag next to link? =
    46 
    47 1. Install [World Flag plugin](http://wordpress.org/extend/plugins/world-flag/)
    48 2. Edit link name and add [flag country="us"]. Shortcodes are supported in link names!
    49 
    50 = It doesn't work! =
    51 
    52 1. Double check if your widget points to the correct menu.
    53 2. Check if menu items have valid Live Stream channel URLs (e.g. `http://www.twitch.tv/tobiwandota`) and names (e.g. `My live stream!`)
    54 
    55 = Status is not displayed next to each Live Stream! =
    56 
    57 Hold on a second. Live stream status is scheduled to be updated every 5 minutes to save your web server resources. If this is your first run, give it a few minutes after activation.
     58No questions yet. [Ask one!](http://wordpress.org/support/plugin/live-stream-badger)
    5859
    5960== Screenshots ==
    … …  
    6465
    6566= 1.0.2-dev =
     67* Added livestream shortcode!
    6668* Implemented pluggable API to support other providers than Twitch in the future
    6769* Major refactoring
Note: See TracChangeset for help on using the changeset viewer.