Skip to content

Commit 7159881

Browse files
committed
updates readme file
1 parent 4cd4f0e commit 7159881

File tree

1 file changed

+18
-23
lines changed

1 file changed

+18
-23
lines changed

README.md

Lines changed: 18 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,27 @@
1-
# Laravel Blogger
1+
# Laravel Blog Package
22
## Easy to install Laravel Package for adding a full blog (with admin backend) to your Laravel app
3-
### 5 minutes to install! Quick and easy!
3+
It has everything you need to quickly and easily add a blog to your laravel app.
4+
5+
### Quick and easy installation
46

57
Install with following command and follow the instructions.
68

79
composer require hessam/laravel-blogger
810

9-
## Introduction
11+
### For Complete Setup Instructions (with video guide), please Visit [The Install Guide](https://hessam.binshops.com/laravel-blog-package/)
1012

11-
It has everything you need to quickly and easily add a blog to your laravel app.
13+
To see package on Packagist click this [Link](https://packagist.org/packages/hessam/laravel-blogger)
1214

15+
## What/who this package is for:
16+
17+
- For websites running Laravel (6.x and higher)
18+
- Who want to have a site blog, and have an easy to use interface to write blog posts/assign categories/manage existing posts
19+
- Where only admin users can edit/manage the blog (this is not suitable for every user on your site to be able to manage posts)
20+
- Where you understand that posts can (potentially) contain JS or any other code, so you should only allow trusted admin users to add/edit/delete/manage the blog posts
1321

14-
## FOR 5 MINUTE INSTALLATION GUIDE (with video guide), PLEASE VISIT [THE INSTALL GUIDE HERE](https://hessam.binshops.com/laravel-blog-package/)
22+
## What this package is NOT for:
1523

16-
[Install guide](https://hessam.binshops.com/laravel-blog-package/)[Packagist](https://packagist.org/packages/hessam/laravel-blogger) << MAKE SURE YOU FOLLOW THE INSTURCTIONS. They're simple, but must be followed.
24+
- Sites where you want your (normal, non-admin) users to write blog posts. You must set `canManageBlogEtcPosts()` on your user model to ONLY allow trusted users.
1725

1826
## Features
1927

@@ -60,18 +68,6 @@ It has everything you need to quickly and easily add a blog to your laravel app.
6068
- and then add 1 method to your `\App\User` file (`canManageBlogEtcPosts()`
6169
- __but please see the install instructions to get everything up and working__
6270

63-
64-
## What/who this package is for:
65-
66-
- For websites running Laravel (6.x and higher)
67-
- Who want to have a site blog, and have an easy to use interface to write blog posts/assign categories/manage existing posts
68-
- Where only admin users can edit/manage the blog (this is not suitable for every user on your site to be able to manage posts)
69-
- Where you understand that posts can (potentially) contain JS or any other code, so you should only allow trusted admin users to add/edit/delete/manage the blog posts
70-
71-
## What this package is NOT for:
72-
73-
- Sites where you want your (normal, non-admin) users to write blog posts. You must set `canManageBlogEtcPosts()` on your user model to ONLY allow trusted users.
74-
7571
## Important notes
7672

7773
1) Anyone who can manage blog posts (defined by the `canManageBlogEtcPosts()` method you add to your User model) can submit any HTML which is echoed out. This is a security issue. If you don't trust the content you should add a custom view and escape the blog content before echoing it, and set `use_custom_view_files` in the config to false.
@@ -144,9 +140,10 @@ After upgraded to latest version follows these steps:
144140
## After Upgrade to 7.2.x
145141
- run `php artisan vendor:publish --provider="WebDevEtc\BlogEtc\BlogEtcServiceProvider"`
146142

147-
## Version History
148-
- 7.2.1 - adds reading progress bar feature (if you upgrade, re-publish config file and view files)
149-
- 7.2.0 - adds sub-category functionality to blog
143+
## Version History
144+
- 7.2.0
145+
- adds sub-category functionality to blog
146+
- adds reading progress bar feature (if you upgrade, re-publish config file and view files)
150147
- 7.1.8 - ability to remove images from posts (this feature does not work for old posts)
151148
- 7.1.7 - updates CKEditor
152149
- 7.1.5 - minor fix for recent posts
@@ -170,8 +167,6 @@ After upgraded to latest version follows these steps:
170167
- 0.3 - Small changes, packagist settings.
171168
- 0.1 - Initial release
172169

173-
## Issues, support, bug reports, security issues
174-
175170
176171

177172

0 commit comments

Comments
 (0)