From 47ef9c8d2b04ed7196cc2c88bbbe45307969dd89 Mon Sep 17 00:00:00 2001 From: Jitendra Adhikari Date: Thu, 26 Oct 2017 21:11:31 +0700 Subject: [PATCH] doc: update readme --- readme.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/readme.md b/readme.md index 360a86a..098f94d 100644 --- a/readme.md +++ b/readme.md @@ -4,20 +4,29 @@ **Concept** - it splits the markdown into lines and parses to markup one by one, finally applies markdown syntaxes on the markup. It supports most of the markdown as in [specs](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet "cheatsheet"). -**Crazy Part:** it is _single class_, _single function_ library, because hey! construct() and toString() are magics - # installation -edit your `composer.json` to include `"adhocore/htmlup": "1.0.*@dev"` in the `require` section and run `composer update`, or run `composer require adhocore/htmlup:1.0.*@dev` +Run `composer require adhocore/htmlup` # usage ```php -require '/path/to/vendor/autoload.php'; +parse($markdownText); ```