Skip to content
This repository was archived by the owner on Nov 23, 2020. It is now read-only.

Commit 94a5c44

Browse files
authored
Update README.MD to make it clearer that this package is unmaintained
Addresses #435
1 parent b3a6ce7 commit 94a5c44

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,23 @@
1-
# Backpack\Base (for Backpack 3.x)
2-
1+
[![Maintained](https://img.shields.io/badge/maintained-no-red)](https://github.com/Laravel-Backpack/Base/pull/435#issuecomment-708341325)
32
[![Latest Version on Packagist][ico-version]][link-packagist]
4-
[![Software License][ico-license]](LICENSE.md)
53
[![Build Status](https://img.shields.io/travis/Laravel-Backpack/base/master.svg?style=flat-square)](https://travis-ci.org/Laravel-Backpack/base)
6-
[![Coverage Status](https://img.shields.io/scrutinizer/coverage/g/laravel-backpack/base.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-backpack/crud/code-structure)
74
[![Quality Score](https://img.shields.io/scrutinizer/g/laravel-backpack/base.svg?style=flat-square)](https://scrutinizer-ci.com/g/laravel-backpack/crud)
85
[![Style CI](https://styleci.io/repos/52384487/shield)](https://styleci.io/repos/52384487)
96
[![Total Downloads][ico-downloads]][link-downloads]
107

8+
**Note: This package is only used by Backpack v3. Starting with Backpack v4, everything this package does is included in [Backpack/CRUD](https://github.com/laravel-backpack/crud) - one package to rule them all.**
9+
1110
Laravel Backpack v3.x's central package, which includes:
1211
- admin login interface, using AdminLTE;
1312
- basic menu;
1413
- pretty error pages;
1514
- alerts system (notification bubbles);
1615

17-
**Note: This package is only used by Backpack v3. Starting with Backpack v4, everything this package does is included in Backpack/CRUD - one package to rule them all.**
1816

17+
## Install on Laravel 7.x, 8.x and up
1918

20-
> ### Security updates and breaking changes
21-
> Please **[subscribe to the Backpack Newsletter](http://backpackforlaravel.com/newsletter)** so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months.
19+
Since September 2019, when we released Backpack 4.x, this package is no longer used. Only Backpack 3.x uses Backpack\Base, and Backpack 3.x will not receive support for Laravel 7.x, 8.x and above. We do encourage you to use Backpack + Laravel 7/8/up, but to do that please use the latest major version of Backpack.
2220

23-
![Example generated CRUD interface](https://backpackforlaravel.com/uploads/screenshots/base_login.png)
2421

2522
## Install on Laravel 6, 5.8, 5.7, 5.6 or 5.5
2623

@@ -50,11 +47,13 @@ php artisan backpack:base:install
5047
3) [optional] Change values in config/backpack/base.php to make the admin panel your own. Change menu color, project name, developer name etc.
5148

5249

53-
## Upgrading from Laravel 5.8 to Laravel 6
50+
## Upgrades
51+
52+
### Upgrading from Laravel 5.8 to Laravel 6
5453
- just upgrade your Laravel version and make sure you're running Backpack/Base 1.1.9 or higher;
5554

5655

57-
## Upgrading from Laravel 5.7 to Laravel 5.8 (or from Base 1.0 to Base 1.1)
56+
### Upgrading from Laravel 5.7 to Laravel 5.8 (or from Base 1.0 to Base 1.1)
5857
- Upgrade to Laravel 5.8; you might need to change your ```backpack/crud``` dependency to ```3.6.*``` in your ```composer.json```;
5958
- in your ```App\Models\BackpackUser``` instead of ```Tightenco\Parental\HasParent```, please use ```Backpack\Base\app\Models\Traits\InheritsRelationsFromParentModel```; [here's the diff](https://github.com/Laravel-Backpack/Base/pull/362/files#diff-f075b83ebb2b1ef3ba84dec14b395607);
6059
- in your ```app/config/backpack/base.php``` please change your ```default_date_format``` and ```default_datetime_format``` to ```Do MMMM YYYY``` and ```Do MMMM YYYY, HH:mm``` respectively;
@@ -87,7 +86,11 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details
8786

8887
## Security
8988

90-
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
89+
_Officially_ this package has:
90+
- stopped receiving updates in Sep 2019;
91+
- stopped receiving _security_ updates in Sep 2020;
92+
93+
However, if you discover any security related issues, please email [email protected] and we'll probably push an update nonetheless. Or at least inform people who are still using this version of the vulnerability. We take security seriously, so we'll go above and beyond to make sure our users' admin panels are safe.
9194

9295
Please **[subscribe to the Backpack Newsletter](http://backpackforlaravel.com/newsletter)** so you can find out about any security updates, breaking changes or major features. We send an email every 1-2 months.
9396

@@ -98,7 +101,7 @@ Please **[subscribe to the Backpack Newsletter](http://backpackforlaravel.com/ne
98101

99102
## License
100103

101-
Backpack is free for non-commercial use and 49 EUR/project for commercial use. Please see [License File](LICENSE.md) and [backpackforlaravel.com](https://backpackforlaravel.com/#pricing) for more information.
104+
Backpack is free for non-commercial use and 69 EUR/project for commercial use. Please see [License File](LICENSE.md) and [backpackforlaravel.com](https://backpackforlaravel.com/#pricing) for more information.
102105

103106
## Hire us
104107

0 commit comments

Comments
 (0)