DOC Update README.md for CMS 5

This commit is contained in:
Guy Sartorelli 2023-04-19 16:15:14 +12:00
parent 6931401749
commit b459172b8b
No known key found for this signature in database
GPG Key ID: F313E3B9504D496A

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` - 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) * `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? ## Aren't these just unit tests?
Almost, but not really. Environment checks differ from unit tests in two important ways: 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 ## Installation
```sh ```sh
$ composer require silverstripe/environmentcheck composer require silverstripe/environmentcheck
``` ```
You'll also need to run `/dev/build`.
### Activating Directly ### Activating Directly
Register checks in your own `_config.php` - see the `_config.php` in this module for some defaults. Don't forget to Register checks in your own `_config.php` - see the `_config.php` in this module for some defaults. Don't forget to