diff --git a/README.md b/README.md index 20985c7..5163172 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,16 @@ Provides an ErrorPage page type for the [Silverstripe CMS](https://github.com/si ## Installation +```sh +composer require silverstripe/errorpage ``` -$ composer require silverstripe/errorpage -``` - -You'll also need to run `dev/build`, which will generate a 500 and 404 error page. ## Limitations -The functionally in this module was separated out from the Silverstripe CMS module and retains some [existing issues](https://github.com/silverstripe/silverstripe-framework/issues/4149). +The functionally in this module was separated out from the Silverstripe CMS module and retains some existing issues. An issue of note is that static error pages are generated but are rarely served up, and rarely re-generated. This can lead to website visitors seeing a stale or broken page in the event of a 500 server error. Contributions are welcome, please open a pull request if you want to add a feature or fix a problem. -## Upgrading from Silverstripe 3.x - ### API changes * `ErrorPage.static_filepath` config has been removed.