WordPress.org
Get WordPress

Plugin Directory

Changeset 672707


Ignore:
Timestamp:
02/24/2013 10:16:26 PM (13 years ago)
Author:
vilmosioo
Message:

Screenshots and README.txt update

Location:
wp-github-tools/trunk
Files:
3 added
1 deleted
1 edited

Legend:

Unmodified
Added
Removed

  • wp-github-tools/trunk/README.txt

    r672690 r672707  
    1616The plugin will cache the GitHub response for a certain time period (default: 1 day). You can change this value to half a day or 1 hour. To get more time frames you will need an additional plugin that extends the cron schedules.
    1717
    18 Shortcodes
    19 ---------
     18= Shortcodes =
    2019
    21 **[gist id='*gist_id*' ]** Embeds a gist in your post
     20**[gist id='*gist_id*' ]**
     21
     22Embeds a gist in your post. Parameters:
    2223
    2324 - *id* (required) The id of the gist you want to embed.
    2425
    2526
    26 **[commits repository='your-repository' count='max-count' title='your-title']** Displays the latest commits from your repository
     27**[commits repository='your-repository' count='max-count' title='your-title']**
     28
     29Displays the latest commits from your repository. Parameters:
    2730
    2831- *repository* (required) The name of the repository you wish to get.
    … …  
    3033- *title* (optional) A title to display before the list (*h2*). Default: none
    3134
    32 PHP functions
    33 ------
     35= PHP functions =
    3436
    3537Feel free to use the Gihub helper class in your theme or plugin development.
    … …  
    4547`<?php WP_Github_Tools_API::get_gists($user); ?>`
    4648
    47 Contribute!
    48 ---------
     49= Contribute! =
    4950
    50 If you have suggestions for a new add-on, feel free to email me at ioo.vilmos@gmail.com. Alternatively, you can fork the plugin from [Gihub]()
    51 
    52 Or follow updates on [Twitter](http://twitter.com/vilmosioo)!
     51If you have suggestions for a new add-on, feel free to contact me on [Twitter](http://twitter.com/vilmosioo). Alternatively, you can fork the plugin from [Gihub](https://github.com/vilmosioo/Github-Tools-for-WordPress)
    5352 
    5453== Installation ==
    5554
    56  1. Download the plugin files and upload them to your `/wp-content/plugins/` directory
    57  2. Activate the plugin through the 'Plugins' menu in WordPress
    58  3. Set your GitHub username using the 'GitHub Tools' page under the Tools menu
    59  4. Ready to go!
     551. Download the plugin files and upload them to your `/wp-content/plugins/` directory
     562. Activate the plugin through the 'Plugins' menu in WordPress
     573. Set your GitHub username using the 'GitHub Tools' page under the Tools menu
     584. Ready to go!
    6059
    6160== Screenshots ==
    … …  
    65643. The commits widget that you can use on any sidebar to deliver live updates for your projects.
    6665
     66== Upgrade Notice ==
     67*   Version 1.0 published!
     68
     69== Frequently Asked Questions ==
     70Send any questions directly to [me](http://twitter.com/vilmosioo)!
     71
    6772== Changelog ==
    6873
    69 = 1.0 20 February 2013=
    70  * Added custom widget to display repository commits.
    71  * Implemented custom shortcode to display repository commits.
    72  * Implemented custom shortcode to embed gists.
    73  * Customizable cache system.
    74  * Live validation of GitHub usernames.
     74= 1.0 =
     75
     76*   Added custom widget to display repository commits.
     77*   Implemented custom shortcode to display repository commits.
     78*   Implemented custom shortcode to embed gists.
     79*   Customizable cache system.
     80*   Live validation of GitHub usernames.
Note: See TracChangeset for help on using the changeset viewer.