diff --git a/README.md b/README.md index 7bf53ac08cd0967d9d8ca08a7b517d271107b7cb..aed7bf401d58b6169ad4382897793043f33bea58 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,26 @@ WordPress Codebird ====================== -*Contributors: @automattic, @batmoo, @danielbachuber, @nickdaugherty* -*Tested up to: 3.5.1* -*Stable tag: 1.0.1* -*License: GPLv2 or later* -*License URI: http://www.gnu.org/licenses/gpl-2.0.html* +* _Contributors: @automattic, @batmoo, @danielbachuber, @nickdaugherty_ +* _Tested up to: 3.5.1_ +* _Stable tag: 1.0.1_ +* _License: GPLv2 or later_ +* _License URI: http://www.gnu.org/licenses/gpl-2.0.html_ Description ----------------------- -An extension of the Codebird class to use WordPress' HTTP API instead of cURL. +An extension of the [Codebird](https://github.com/mynetx/codebird-php) class to use WordPress' HTTP API instead of cURL. -Provides a drop in replacement for Codebird (mynetx/codebird-php) with improved WordPress integration by replacing all cURL calls with WordPress HTTP API calls. +Provides a drop in replacement for Codebird with improved WordPress integration by replacing all cURL calls with WordPress HTTP API calls. Usage -------------------- Include both the Codebird library and `class-wp-codebird.php`, then get a new instance of `WP_Codebird`: - $wp_codebird = WP_Codebird::getInstance(); +```php +$wp_codebird = WP_Codebird::getInstance(); +``` The rest of the api is identical to Codebird - it is a drop in replacement that does not require any modification to existing code. \ No newline at end of file