WordPress.org

Plugin Directory

Changeset 673918


Ignore:
Timestamp:
02/27/13 06:00:56 (5 years ago)
Author:
amattie
Message:

updated readme.txt and added screenshots

File:
1 edited

Legend:

Unmodified
Added
Removed
  • oh-hey-world/trunk/readme.txt

    r661715 r673918  
    66Stable tag: trunk 
    77 
    8 Oh Hey World is the inside connection to the world around you. This plugin compliments your Oh Hey World profile. 
     8Oh Hey World is the easiest way to share your safe arrival in a new city with those who care. This plugin compliments your Oh Hey World profile. 
    99 
    1010== Description == 
     
    1717 
    1818In addition to the sidebar widget, there are two shortcodes: 
    19 * [currentlocation user_slug="username"] - Pulls in the pure text of your latest check-in on Oh Hey World. For example, if you are checked-in to New York, the text returned will be "New York, New York, United States". 
    20 * [currentbadge user_slug="username"] - Pulls in the widebar widet and embeds it inside of a page or post. 
     191. [currentlocation user_slug="username"] - Pulls in the pure text of your latest check-in on Oh Hey World. For example, if you are checked-in to New York, the text returned will be "New York, New York, United States". 
     201. [currentbadge user_slug="username"] - Pulls in the widebar widet and embeds it inside of a page or post. 
     21 
     22Important Notes 
     23* Your user name can be found in the URL structure of your profile. For the profile http://beta.ohheyworld.com/drewmeyers/profile, the user name is "drewmeyers" 
     24*Your web host must be running at least PHP 5.2. PHP 5.2 has been out for more than 3 years at this point, so if they aren’t using PHP 5.2, they’re quite a ways behind the times. This is almost never an issue nowadays. 
     25*You must be using at least WordPress 3.4. 
    2126 
    2227Note: If you're searching for oheyworld, ohheyworld, ohh hey world, or ohhheyworld this is the plugin you're probably looking for. 
     28 
     29== Installation == 
     30 
     31How to install the plugin and get it working. 
     32 
     331. Click add new plugin and search for & add "Oh Hey World" (or upload `oh-hey-world.zip to the `/wp-content/plugins/` directory). 
     341. Activate the plugin through the 'Plugins' menu in WordPress 
     351. Grab your user name from your Oh Hey World profile. If the link to your profile is http://www.ohheyworld.com/drewmeyers/profile, your profile name is "drewmeyers" 
     361. Insert the sidebar widget into your sidebar or use one of the two short codes to insert the text into your about page (or any other post or page). 
     371. Update your location on Oh Hey World every time you change locations by checking-in on the BETA site at your current location. 
     38 
     39== Frequently Asked Questions == 
     40 
     41= How long does it take for my travel blog to update once I check-in on Oh Hey World? = 
     42 
     43The Oh Hey World plugin caches the results for 60 seconds. If a recent check-in is not updating on your blog quickly, it's likely the result of a plugin (such as WP Super Cache) that caches your site to improve load time. To resolve, adjust your caching settings. 
     44 
     45= Can I style the widget with custom CSS? = 
     46 
     47The widget currently automatically takes on the CSS of your WordPress theme. Longer term  - we know some people want custom CSS controls, and it’s on our list of enhancements we’re considering. 
     48 
     49= What if the plugin doesn’t work with my theme? = 
     50 
     51We’ve worked hard to make this plugin work on as many themes as possible, but it’s impossible for us to ensure it works with every single theme ever created. Unfortunately we can’t troubleshoot code on individual sites at this time. That said, please leave feedback via our feedback form. 
     52 
     53= How can I suggest improvements or report bugs with the plugin? = 
     54 
     55Please submit them via the feedback page on Oh Hey World. 
     56 
     57== Screenshots == 
     58 
     591. This screen shot description corresponds to to the widget used on Where SideWalks End.  
     602. This screen shot description corresponds to to the short code used on A Little Adrift. 
     61 
     62== Changelog == 
     63 
     64= 1.0 = 
     65* Added ability to hide the flag and the days on road. 
     66* Option to display different size flags 
Note: See TracChangeset for help on using the changeset viewer.