readme update

Author: samberrry

README.md

@@ -1,28 +1,24 @@
-# Laravel Blog
-Single language version of Binshops Laravel Blog 
+ <h1 align="center">Laravel Blog Package</h1>
 
-### Contact us for any customization:
-[email protected]
+<p align="center">
+    <img src="https://user-images.githubusercontent.com/20775532/215362765-c2a3360e-c165-4cba-809b-4f04316c8d5e.png" width="80%" />
+</p>
 
-### Lightweight and Comprehensive
+### Lightweight and Easy to Install
 
-Incredible features with a lightweight laravel blog package. I highly recommend it because:
+Incredible features with a lightweight laravel blog package.
 - Quick installation (<3 minutes)
 - It's very easy to extend
 - Included great features out-of-box
 - Its simplicity allows to be easily made compatible with latest laravel
 - No additional concept except laravel knowledge
-- Compatible with other Laravel platforms like Bagisto
-
-## Outstanding Features
 - Fulltext Search - search throughout all blog posts
 - Multi Level Category - nested sets using Baum
-- Multi Language Support
 
-### Quick and easy installation
+### Quick and easy installation (Multi-lang version)
 1- Install via composer
 
-`composer require binshops/laravel-blog:v8.2.0`
+`composer require binshops/laravel-blog`
 
 For a fresh Laravel installation run the following too:
 
@@ -31,15 +27,21 @@ composer require laravel/ui
 php artisan ui vue --auth
 ```
 
-2- Run the following two commands to copy config file, migration files, and view files
+2- Scaffold
+
+```
+npm install && npm run build
+```
+
+3- Run the following two commands to copy config file, migration files, and view files
 
 `php artisan vendor:publish --provider="BinshopsBlog\BinshopsBlogServiceProvider"`
 
-3- Execute migrations to create tables
+4- Execute migrations to create tables
 
 `php artisan migrate;`
 
-4- You must add one method to your \App\User (in laravel 8 \App\Models\User) model. As the name of this method shows it determines which user can manage posts. Place your logic there
+5- You must add one method to your \App\User (in laravel 8 \App\Models\User) model. As the name of this method shows it determines which user can manage posts. Place your logic there
 
 ```
  /**
@@ -72,17 +74,33 @@ php artisan ui vue --auth
     }
 ```
 
-5- Create a directory in `public/` named `blog_images`
+6- Create a directory in `public/` named `blog_images`
+
+7- Start the server
+
+```
+php artisan serve
+```
 
-Congrats! Your blog is ready to use. (URLs are customizable in the config file)
+Congrats! Your blog is ready to use. Now you can log in as admin. (URLs are customizable in the config file)
 
-Admin panel URI: `/blog_admin`
-Front URI: `/blog`
+Default Admin panel URI: `/blog_admin`
+Default Front URI: `/en/blog`
 
 To see package on Packagist click this [Link](https://packagist.org/packages/binshops/laravel-blog)
 
-### Bagisto version
-To see the Bagisto version of this package go to `bagisto-compatible` branch
+### Single Language Version
+To install the single language version of the package use version v8.1x:
+
+1- `composer require binshops/laravel-blog:v8.2.0`
+
+2- `php artisan vendor:publish --provider="BinshopsBlog\BinshopsBlogServiceProvider"`
+
+3- `php artisan vendor:publish --tag=laravel-fulltext`
+
+4- `php artisan migrate;`
+
+You can see the single version in "single-lang" branch. The major difference with multi-language version is the database structure.
 
 ## Important Notes
 - For laravel 8.x's default auth User model, change user model in `binshopsblog.php` to: `\App\Models\User::class`
@@ -108,7 +126,7 @@ To see the Bagisto version of this package go to `bagisto-compatible` branch
 ## What/who this package is for:
 
 - For websites running Laravel
-- Who wants to have a site blog. This laravel blog gives an easy to use interface to write blog posts/assign categories/manage existing posts
+- Anyone, who wants to have a site blog. This laravel blog gives an easy to use interface to write blog posts/assign categories/manage existing posts
 - 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)
 - For anyone who likes to add a wordpress-like laravel blog to laravel website
 
@@ -141,9 +159,31 @@ Add these (and an Event Listener) to your `EventServiceProvider.php` file to mak
 
 ## Built in CAPTCHA / anti spam
 
-There is a built in captcha (anti spam comment) system built in, which will be easy for you to replace with your own implementation.
+There is a built-in captcha (anti-spam comment) system built in, which will be easy for you to replace with your own implementation.
 
-Please see [this Captcha docs](https://binshops.binshops.com/laravel-blog-package#captcha) for  more details.
+There is a basic anti-spam captcha function built-in.
+
+See the config/binshops.php captcha section. There is a built in system (basic!) that will prevent most automated spam attempts.
+Writing your own captcha system:
+
+I wrote the captcha system simple on purpose, so you can add your own captcha options. It should be easy to add any other captcha system to this.
+
+If you want to write your own implementation then create your own class that implements \BinshopsBlog\Interfaces\CaptchaInterface, then update the config/binshopsblog.php file (change the captcha_type option).
+
+There are three methods you need to implement:
+public function captcha_field_name() : string
+
+Return a string such as "captcha". It is used for the form validation and <input name=???>.
+public function view() : string
+
+What view file should the binshops::partials.add_comment_form view include? You can set this to whatever you need, and then create your own view file. The default included basic captcha class will return "binshops::captcha.basic".
+public function rules() : array
+
+Return an array for the rules (which are just the standard Laravel validation rules. This is where you can check if the captcha was successful or not.
+Optional:
+public function runCaptchaBeforeShowingPosts() : null
+
+This isn't part of the interface, it isn't required. By default it does nothing. But you can put some code in this method and it'll be run in the BinshopsReaderController::viewSinglePost method.
 
 ## Image upload errors
 
@@ -156,43 +196,14 @@ Try adding this to config/app.php:
 - You might need to set a higher memory limit, or upload smaller image files. This will depend on your server. I've used it to upload huge (10mb+) jpg images without problem, once the server was set up correctly to handle larger file uploads.
 
 ## Version History
-- **9.2.x** Stable version of package
+- **10.x** Stable version - Compatibility with laravel 11, 12
+- 9.3.x Old multi lang
 - 9.0.x Multi-language support beta release
 - 8.0.x Compatibility with Laravel 8
-- 7.3.2 Some bug fixes
 - 7.3.0 New Admin UI
-- 7.2.2
-  - bug fix: do not show search bar when it's disabled
-  - feature: configure to show full text post or preview
-- 7.2.1                 - adds logout button at admin panel
-- 7.2.0
-  - adds sub-category functionality to blog
-  - adds reading progress bar feature (if you upgrade, re-publish config file and view files)
-- 7.1.8                 - ability to remove images from posts (this feature does not work for old posts)
-- 7.1.7                 - updates CKEditor
-- 7.1.5                 - minor fix for recent posts
-- 7.1.4                 - updates fulltext search package which solves the search issue
-- 7.1.2                 - shows categories on blog home page - minor fix (if you upgrade try to re-publish view files)
-- 7.1.1                 - minor fix and some admin panel text changes
-- 7.1.0                 - Adds support for custom user model (if you upgrade, try to publish new config)
-- 7.0.2                 - Bug fix for listing posts and search page
-- 7.0.1                 - made compatible with Laravel 6.x & 7.x
-- 3.1                   - minor fixes
-- 3.0.3                 - fixed RSS feed cache issue
-- 3.0.2                 - fixed default medium image size (changed to 600x400)
 - 3.0.1                 - replaced all short tags (<?) with full opening ones (<?php)
-- 3.0                   - Added separate functionality for uploading images (and save some meta data in db)
-- 2.1                   - added 'short_description' to db + form, and BinshopsBlogPost::generate_introduction() method will try and use this to generate intro text.
 - 2.0                   - added full text search (enable it via the config file - it is disabled by default).
-- 1.2                   - added WYSIWYG, few smaller changes
 - 1.1.1                 - added basic captcha
 - 1.0.5                 - composer.json changes.
 - 1.0                   - First release
-- 0.3                   - Small changes, packagist settings.
 - 0.1                   - Initial release
-
-Contact: [email protected]
-
-
-
-