tonyair
/
silverstripe-environmentcheck
mirror of https://github.com/silverstripe/silverstripe-environmentcheck
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #88 from creative-commoners/pulls/3.0/cms5-readme 

DOC Update README.md for CMS 5
This commit is contained in:
Sabina Talipova 2023-04-21 14:44:56 +12:00 committed by GitHub
parent 6931401749 b459172b8b
commit 8b98c6fa5c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -9,13 +9,6 @@ This module adds an API for running environment checks to your API.
* `dev/check` - An admin-only URL that performs a more comprehensive set of checks. This could be tied to a deployment system, for example.
* `dev/check/<suite>` - Check a specific suite (admin only)
## Requirements
* Silverstripe 4.x
* PHP 7.3
For Silverstripe 3.x support, please use a `1.x` tagged release.
## Aren't these just unit tests?
Almost, but not really. Environment checks differ from unit tests in two important ways:
@ -26,11 +19,9 @@ Almost, but not really. Environment checks differ from unit tests in two importa
## Installation
```sh
$ composer require silverstripe/environmentcheck
composer require silverstripe/environmentcheck
```
You'll also need to run `/dev/build`.
### Activating Directly
Register checks in your own `_config.php` - see the `_config.php` in this module for some defaults. Don't forget to