diff --git a/README.md b/README.md index e8f5ed7..8f086ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,25 @@ +[Parsedown PHP](http://parsedown.org) +=== + Parsedown is a parser for Markdown. It parses Markdown text the way people do. First, it divides texts into blocks. Then it looks at how these blocks start and how they relate to each other. Finally, it looks for special characters to identify inline elements. As a result, Parsedown is (super) fast, consistent and clean. [Explorer (demo)](http://parsedown.org/explorer/) [Tests](http://parsedown.org/tests/) +### Installation + +Include `Parsedown.php` or install [the composer package](https://packagist.org/packages/erusev/parsedown). + +### Example + +```php +$text = 'Hello **Parsedown**!'; + +$result = Parsedown::instance()->parse($text); + +echo $result; # prints:

Hello Parsedown!

+``` + --- [![Coverage Status](https://coveralls.io/repos/erusev/parsedown/badge.png?branch=master)](https://coveralls.io/r/erusev/parsedown?branch=master) \ No newline at end of file