From 21db821324526ad0bdcec7dd1b1b9066fd9b2e64 Mon Sep 17 00:00:00 2001 From: Emanuil Rusev Date: Fri, 16 May 2014 01:15:21 +0300 Subject: [PATCH] improve readme --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 73e0c44..27a0bdf 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,7 @@ Better [Markdown](http://en.wikipedia.org/wiki/Markdown) parser for PHP. -- [Demo](http://parsedown.org/demo) -- [Tests](http://parsedown.org/tests/) +* [Demo](http://parsedown.org/demo) ### Features @@ -21,7 +20,18 @@ Include `Parsedown.php` or install [the composer package](https://packagist.org/ ### Example ``` php -$Parsedown = new Parsedown(); +$parsedown = new Parsedown(); -echo $Parsedown->text('Hello _Parsedown_!'); # prints:

Hello Parsedown!

+echo $parsedown->text('Hello _Parsedown_!'); # prints:

Hello Parsedown!

``` + +### Questions + +\- How does Parsedown work? +\- Parsedown recognises that the Markdown syntax is optimised for humans so it tries to read like one. It goes through text line by line. It looks at how lines start to identify blocks. It looks for special characters to identify inline elements. + +\- Why doesn’t Parsedown use namespaces? +\- Using namespaces would mean dropping support for PHP 5.2. Since Parsedown is a single class with an uncommon name, making this trade wouldn't make much sense. + +\- Who uses Parsedown? +\- [phpDocumentor](http://www.phpdoc.org/), [Bolt CMS](http://bolt.cm/), [RaspberryPi.org](http://www.raspberrypi.org/) and [more](https://www.versioneye.com/php/erusev:parsedown/references).