Plugin Directory

Changeset 1594981


Ignore:
Timestamp:
02/13/2017 02:20:45 PM (9 years ago)
Author:
Ginchen
Message:

Changed readme

File:
1 edited

Legend:

Unmodified
Added
Removed
  • feed-widget-for-runkeeper-activities/trunk/readme.txt

    r1594977 r1594981  
    1212
    1313== Description ==
    14 This widget shows your latest activities from runkeeper.com. The number of activities can be configured, as can the values that are being displayed (distance, speed, duration, calories burned). The widget may also be called using the [runkeeper] shortcode. A little bit of effort is required to set it up, but it's worth it, because this way, no third party will ever get access to your data. Everything stays between your WordPress site and Runkeeper.
     14
     15This widget shows your latest activities from runkeeper.com. The number of activities can be configured, as can the values that are being displayed (distance, speed, duration, calories burned). The widget may also be called using the [runkeeper] shortcode.
     16
     17A little bit of effort is required to set it up, but it's worth it, because this way, no third party will ever get access to your data. Everything stays between your WordPress site and Runkeeper.
    1518
    1619== Installation ==
    1720You need to create a Runkeeper Application first. It's worth it, because this way, no third party will ever get access to your data. Everything stays between your WordPress site and Runkeeper.
     21
    18221. Go to the [Runkeeper Partner Portal](https://runkeeper.com/partner)
    19231. If asked, log in with your Runkeeper credentials.
     
    2529
    2630Now you are ready to enable and connect the plugin:
     31
    27321. Extract the plugin folder to your "wp-content/plugins" directory.
    28331. Activate the plugin through the "Plugins" menu in WordPress.
     
    3136
    3237== Frequently Asked Questions ==
     38
    3339= How to configure the widget when called from the shortcode? =
     40
    3441The shortcode offers all the same options that are available when adding the widget from the "Widgets" page. You can use them like this (the values given here are the defaults):
     42
    3543[runkeeper title="" numposts=5 unit="km" showlogo=true showdate=true showtime=true showdistance=true showduration=true showspeed=false showcalories=false dateformat="n/j/Y" timeformat="g:i a"]
    3644
    3745Notes:
    38 - *numposts* defines how many recent activities to display.
    39 - *unit* can be "km" or "miles".
    40 - *showtime=true* will only display the time, if showdate is true as well.
    41 - *dateformat* and *timeformat* take a [PHP date format](http://php.net/manual/en/function.date.php).
     46
     47* **numposts** defines how many recent activities to display.
     48* **unit** can be "km" or "miles".
     49* **showtime=true** will only display the time, if showdate is true as well.
     50* **dateformat** and *timeformat* take a [PHP date format](http://php.net/manual/en/function.date.php).
    4251
    4352== Screenshots ==
     53
    44541. Widget with default settings.
    45552. Displayed values can be customized, and the plugin is translation-ready.
     
    4757
    4858== Changelog ==
     59
    4960= 0.1 =
     61
    5062* Initial release.
Note: See TracChangeset for help on using the changeset viewer.