Skip to content

Commit 6402188

Browse files
committed
Update docs
1 parent 66a7bfd commit 6402188

File tree

3 files changed

+25
-4
lines changed

3 files changed

+25
-4
lines changed

.env.example

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
STAGEFRONT_ENABLED=true
22
STAGEFRONT_URL=stagefront
3+
STAGEFRONT_LIVE_SITE=null
34

45
STAGEFRONT_LOGIN=stagefront
56
STAGEFRONT_PASSWORD=stagefront
@@ -11,4 +12,6 @@ STAGEFRONT_DATABASE_TABLE=users
1112
STAGEFRONT_DATABASE_LOGIN_FIELD=email
1213
STAGEFRONT_DATABASE_PASSWORD_FIELD=password
1314

14-
STAGEFRONT_LIVE_SITE=null
15+
STAGEFRONT_THROTTLE=true
16+
STAGEFRONT_THROTTLE_TRIES=3
17+
STAGEFRONT_THROTTLE_DELAY=5

CHANGELOG.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,9 @@ All Notable changes to `StageFront` will be documented in this file.
55
## 1.0.0 (2017-10-10)
66

77
- Version 1.0.0 of `StageFront`
8+
9+
## 1.1.0 (2017-10-10)
10+
11+
- Add login throttling
12+
- Autoload middleware
13+
- Disable Laravel Debugbar on all StageFront routes

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,16 @@
99

1010
#### Quickly add some password protection to a staging site.
1111

12+
Shielding a staging or demo website from the public usually involves setting op authentication separate from the actual project. This isn't always easy or is cumbersome at the least.
13+
14+
It doesn't have to be!
15+
16+
By installing StageFront with composer and setting 3 variables in your `.env` you are ready to go. As you will discover below, you also have a bunch more options available.
17+
1218
## Requirements
1319

1420
- PHP >= 7.0
15-
- Laravel >= 5.5
21+
- [Laravel](https://laravel.com/) >= 5.5
1622

1723
## Installation
1824

@@ -24,11 +30,13 @@ composer require codezero/laravel-stagefront
2430

2531
Laravel will automatically register the [`ServiceProvider`](https://github.com/codezero-be/laravel-stagefront/blob/master/src/StageFrontServiceProvider.php) and the [`RedirectIfStageFrontIsEnabled`](https://github.com/codezero-be/laravel-stagefront/blob/master/src/Middleware/RedirectIfStageFrontIsEnabled.php) middleware. You just need to set some `.env` variables and your up and running!
2632

33+
When StageFront is disabled, its routes and middleware will not be registered.
34+
2735
## Quick Setup
2836

2937
Set some options in your `.env` file or publish the [configuration file](#publish-configuration-file).
3038

31-
See an [example .env file](.env.example).
39+
See an [example .env file](https://github.com/codezero-be/laravel-stagefront/blob/master/.env.example).
3240

3341
Enable StageFront and choose a login and password:
3442

@@ -158,6 +166,10 @@ vendor/bin/phpunit
158166

159167
If you discover any security related issues, please [e-mail me](mailto:ivan@codezero.be) instead of using the issue tracker.
160168

169+
## Changelog
170+
171+
See a list of important changes in the [changelog](https://github.com/codezero-be/laravel-stagefront/blob/master/CHANGELOG.md).
172+
161173
## License
162174

163-
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
175+
The MIT License (MIT). Please see [License File](https://github.com/codezero-be/laravel-stagefront/blob/master/LICENSE.md) for more information.

0 commit comments

Comments
 (0)