Make README.md nicer for Doxygen processing

bd808 · legoktm · commit 215841afe3d9 · 2015-06-17T23:16:52.000Z
Follow the lead of the changes in I5e1bf85 for the at-ease library to make README.md play nicer with Doxygen's markdown processor: * Images used as the text of a link aren't rendered by Doxygen's markdown processor. Move the image source to a named link to make the output look a little nicer. * Doxygen isn't recognizing "```" as a fenced code block delimiter (even though it is documented as an alternate syntax [0]) so use 4 spaces to mark code blocks instead. [0]: http://michelf.com/projects/php-markdown/extra/#fenced-code-blocks Change-Id: Ifc3b3f1d4f512dd12edd715ca2c2a5682c63a4b0
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![Latest Stable Version](https://poser.pugx.org/wikimedia/cdb/v/stable.svg)](https://packagist.org/packages/wikimedia/cdb) [![License](https://poser.pugx.org/wikimedia/cdb/license.svg)](https://packagist.org/packages/wikimedia/cdb)
+[![Latest Stable Version]](https://packagist.org/packages/wikimedia/cdb) [![License]](https://packagist.org/packages/wikimedia/cdb)
 
 CDB functions for PHP
 =====================
@@ -9,29 +9,28 @@ library wraps the CDB functionality exposed in PHP via the `dba_*` functions.
 In cases where `dba_*` functions are not present or are not compiled with CDB
 support, a pure-PHP implementation is provided for falling back.
 
-Additional documentation about the library can be found on [MediaWiki.org](https://www.mediawiki.org/wiki/CDB).
+Additional documentation about the library can be found on
+[MediaWiki.org](https://www.mediawiki.org/wiki/CDB).
 
 
 Usage
 -----
 
-```
-// Reading a CDB file
-$cdb = \Cdb\Reader::open( 'db.cdb' );
-$foo = $cdb->get( 'somekey' );
+    // Reading a CDB file
+    $cdb = \Cdb\Reader::open( 'db.cdb' );
+    $foo = $cdb->get( 'somekey' );
+
+    // Writing to a CDB file
+    $cdb = \Cdb\Writer::open( 'anotherdb.cdb' );
+    $cdb->set( 'somekey', $foo );
 
-// Writing to a CDB file
-$cdb = \Cdb\Writer::open( 'anotherdb.cdb' );
-$cdb->set( 'somekey', $foo );
-```
 
 Running tests
 -------------
 
-```
-composer install --prefer-dist
-composer test
-```
+    composer install --prefer-dist
+    composer test
+
 
 History
 -------
@@ -40,8 +39,11 @@ This library was first introduced in [MediaWiki 1.16][] ([r52203][]). It was
 split out of the MediaWiki codebase and published as an independent library
 during the [MediaWiki 1.25][] development cycle.
 
+
 ---
 [CDB]: https://en.wikipedia.org/wiki/cdb_(software)
 [MediaWiki 1.16]: https://www.mediawiki.org/wiki/MediaWiki_1.16
 [r52203]: https://www.mediawiki.org/wiki/Special:Code/MediaWiki/52203
 [MediaWiki 1.25]: https://www.mediawiki.org/wiki/MediaWiki_1.25
+[Latest Stable Version]: https://poser.pugx.org/wikimedia/cdb/v/stable.svg
+[License]: https://poser.pugx.org/wikimedia/cdb/license.svg
