Skip to content

Commit e639e72

Browse files
authored
Update README.md
1 parent a7a6861 commit e639e72

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,21 @@
1-
# Shortcode
1+
# Shortcode Component
2+
![version](https://img.shields.io/badge/version-1.1.0-brightgreen.svg?style=flat-square "Version")
3+
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://github.com/flextype-components/shortcode/blob/master/LICENSE)
24

3-
The Shortcode Class is a simple regex based parser that allows you to replace simple bbcode-like tags within a HTMLText or HTMLVarchar field when rendered into a content.
5+
The Shortcode Component is a simple regex based parser that allows you to replace simple bbcode-like tags within a HTMLText or HTMLVarchar field when rendered into a content.
6+
7+
8+
### Installation
9+
10+
```
11+
composer require flextype-components/shortcode
12+
```
13+
14+
### Usage
15+
16+
```php
17+
use Flextype\Component\Shortcode\Shortcode;
18+
```
419

520
Examples of shortcode tags:
621

0 commit comments

Comments
 (0)