From 79eb220a5b63f0dc0c12d94e01ce8fb7590ecfaa Mon Sep 17 00:00:00 2001 From: Nikolay Kostyurin Date: Fri, 20 Jul 2018 09:51:14 +0200 Subject: [PATCH] chore(parser): update usage in readme --- packages/bbob-parser/README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/packages/bbob-parser/README.md b/packages/bbob-parser/README.md index 83b83de..d45cbd3 100644 --- a/packages/bbob-parser/README.md +++ b/packages/bbob-parser/README.md @@ -3,9 +3,19 @@ Parses BBCode and returns AST Tree looks like +## Usage -`[url=]hello world![/url]` -to +```js +import parse from '@bbob/parser' + +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]') +``` + +## Results ```json [