Skip to content

Commit 29c2772

Browse files
committed
Updated readme
1 parent 7175b89 commit 29c2772

File tree

2 files changed

+24
-8
lines changed

2 files changed

+24
-8
lines changed

contributing.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ Contributions are welcome and will be fully credited.
44

55
Contributions are accepted via Pull Requests on [Github](https://github.com/vedmant/laravelshortcodes).
66

7-
# Things you could do
8-
If you want to contribute but do not know where to start, this list provides some starting points.
9-
- Add license text
10-
- Remove rewriteRules.php
11-
- Set up TravisCI, StyleCI, ScrutinizerCI
12-
- Write a comprehensive ReadMe
13-
147
## Pull Requests
158

169
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.

readme.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,30 @@
11
# Laravel Shortcodes
22

33
[![Latest Version on Packagist][ico-version]][link-packagist]
4+
[![Software License][ico-license]](license.md)
45
[![Total Downloads][ico-downloads]][link-downloads]
56
[![Build Status][ico-travis]][link-travis]
67
[![StyleCI][ico-styleci]][link-styleci]
78

8-
This is where your description should go. Take a look at [contributing.md](contributing.md) to see a to do list.
9+
Wordpress based Shortcodes for Laravel 5.x with shared variables, debugbar integration,
10+
flexible configuration and other useful features.
11+
12+
Build powerful and simple layouts using shortcodes in the content or views like this:
13+
14+
```php
15+
[b]Bold text[/b]
16+
17+
[row]
18+
[col md=8]
19+
[posts_list types="post,gallery" show_tags="yes"]
20+
[/col]
21+
[col md=4]
22+
[poll id="1"]
23+
[user_info username="test_user" website="mywebsite.com" active="yes"]
24+
[last_free_post title="Free Posts"]
25+
[/col]
26+
[/row]
27+
```
928

1029
## Installation
1130

@@ -17,6 +36,9 @@ $ composer require vedmant/laravel-shortcodes
1736

1837
This package supports Laravel Auto-Discover and will be discovered automatically.
1938

39+
For Laravel version before 5.5 please add the Vedmant\LaravelShortcodes\LaravelShortcodesServiceProvider::class to the providers array in `config/app.php`.
40+
And optionally 'Shortcodes' => Vedmant\LaravelShortcodes\Facades\Shortcodes::class, to aliases.
41+
2042

2143
## Configuraton
2244

@@ -134,6 +156,7 @@ $ composer test
134156
1. shortcodes() helper
135157
1. Add unit tests
136158
1. Shortcodes help data generator
159+
1. Add basic bootstrap shortcodes set
137160
1. Casting attributes (int, bool, array (comma separated))
138161
1. Add commands to generate a shortcode view, generate view by default with make:shortcode
139162
1. Optional attributes validation

0 commit comments

Comments
 (0)