From 283a9d382ca25612c751f85751653a95c8063d5b Mon Sep 17 00:00:00 2001 From: Maximilian Schmidt Date: Wed, 23 Dec 2020 14:01:50 +0100 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 8335a65..0668491 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ A small plugin for the awesome Neos CMS, to improve debugging of Fusion DSL code - [Table of Contents](#table-of-contents) - [Overview](#overview) - [Installation](#installation) + - [Usage outside of Neos](#usage-outside-of-neos) - [Troubleshooting](#troubleshooting) - [`Invalid controller class name "". Make sure your controller is in a folder named "Command" and it's name ends in "CommandController"`](#invalid-controller-class-name--make-sure-your-controller-is-in-a-folder-named-command-and-its-name-ends-in-commandcontroller) - [Support for older Neos / PHP](#support-for-older-neos--php) @@ -55,15 +56,22 @@ If composer refuses to install the plugin, try requiring a specific version of i The major version of this project will always work with the corresponding Neos release. ``` bash +composer require --dev mcstreetguy/fusion-debugger:^7.0 # for Neos v7.x composer require --dev mcstreetguy/fusion-debugger:^5.0 # for Neos v5.x composer require --dev mcstreetguy/fusion-debugger:^4.0 # for Neos v4.x composer require --dev mcstreetguy/fusion-debugger:^3.0 # for Neos v3.x ``` -We support all Neos versions ranging from 3.0 up to 5.3 officially. +We support all Neos versions ranging from 3.0 up to 7.0 officially. For any other version you may encounter unexpected issues and there is no guarantee that the debugger will work properly! (Even though we kind of support Neos v2.3, see [below](#support-for-older-neos--php) for more information.) +### Usage outside of Neos + +As the plugin only relies on `neos/flow` and `neos/fusion` as dependencies, you can actually use it outside of Neos projects as long as both required components are available. +Testing this is currently an ongoing process, but any feedback on compatibility outside Neos is greatly appreciated. +If you come across any issues not covered in the [troubleshooting section below](#troubleshooting), please [report them](https://github.com/MCStreetguy/fusion-debugger/issues). + ### Troubleshooting #### `Invalid controller class name "". Make sure your controller is in a folder named "Command" and it's name ends in "CommandController"` @@ -80,14 +88,6 @@ In some edge cases it might happen that the entire Flow CLI stops working upon i In that case you are required to manually empty the corresponding `Data/Temporary` directory, that will get Flow running again. If you are uncertain which directories to remove, you may also delete the entire directory at once, causing Flow to regenerate it fully. -If you encounter this error on a production server you also may need to flush the caches for 'Production'-context. - -``` bash -FLOW_CONTEXT=Production /path/to/flow flow:cache:flush --force -``` - -**However, you should not install debugger tools in a production environment anyway!** - ### Support for older Neos / PHP The plugin normally is written vor Neos v3.3 and above and in addition makes extensive use of PHP7.1 features.