From ade8424cebe9d10a8d492d01c93a3f954eaa4fbd Mon Sep 17 00:00:00 2001 From: Nikolay Kostyurin Date: Fri, 20 Jul 2018 23:36:43 +0200 Subject: [PATCH] chore(parser): update readme --- packages/bbob-parser/README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/bbob-parser/README.md b/packages/bbob-parser/README.md index 89e90ca..1b9df5b 100644 --- a/packages/bbob-parser/README.md +++ b/packages/bbob-parser/README.md @@ -1,7 +1,8 @@ # @bbob/parser [![install size](https://packagephobia.now.sh/badge?p=@bbob/parser)](https://packagephobia.now.sh/result?p=@bbob/parser) [![Known Vulnerabilities](https://snyk.io/test/github/JiLiZART/bbob/badge.svg?targetFile=packages%2Fbbob-parser%2Fpackage.json)](https://snyk.io/test/github/JiLiZART/bbob?targetFile=packages%2Fbbob-parser%2Fpackage.json) -Parses BBCode and returns AST Tree valid for use in [posthtml-render](https://github.com/posthtml/posthtml-render) +Parses BBCode and returns AST Tree +Valid for use with [posthtml-render](https://github.com/posthtml/posthtml-render) ## Usage @@ -12,7 +13,7 @@ const options = { onlyAllowTags: ['url', 'h'], onError: (err) => console.warn(err.message, err.lineNumber, err.columnNumber) } -const ast = parse('[url=https://github.com/JiLiZART/bbob/tree/master/packages/bbob-parser]hello world![/url]', options) +const ast = parse('[url=https://github.com]hello world![/url]', options) ``` ## Results @@ -22,7 +23,7 @@ const ast = parse('[url=https://github.com/JiLiZART/bbob/tree/master/packages/bb { "tag": "url", "attrs": { - "url": "https://github.com/JiLiZART/bbob/tree/master/packages/bbob-parser" + "url": "https://github.com" }, "content": ["hello", " ", "world!"] }