diff --git a/CHANGELOG.md b/CHANGELOG.md index 41cc6059..4d0a7e50 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,7 @@ Latest ------ ## Changes +* [#320](https://github.com/cleverage/process-bundle/issues/320) README: add an installation section (`composer require`, bundle registration without Symfony Flex), linking to the quick start. * [#319](https://github.com/cleverage/process-bundle/issues/319) Composer: require PHP `^8.2` instead of `>=8.2` (PHP 9 is no longer accepted before being tested), remove the authorization of the `symfony/flex` plugin, which is not required (the CI installs it globally). * [#318](https://github.com/cleverage/process-bundle/issues/318) `CommandRunnerTask`, `ProcessLauncherTask` and `SubprocessInstance` receive the project directory, the path of the console and the environment (`%kernel.project_dir%`, `%kernel.environment%`) instead of the kernel: passing a `KernelInterface` is deprecated, the arguments will only accept strings in v6.0. `SubprocessInstance` writes the JSON buffer of `ProcessLauncherTask` (`json_buffering`) in the system temporary directory instead of `var/` of the project (which may be read-only), no longer creates the unused `/process` directory, and omits `--env` when no environment is given (default environment of the console). Update documentation, add tests. * [#317](https://github.com/cleverage/process-bundle/issues/317) The bundle throws exceptions implementing `ProcessExceptionInterface` instead of raw SPL exceptions (124 `throw`): new `Exception\UnexpectedValueException`, `RuntimeException`, `InvalidArgumentException` and `LogicException`, extending the SPL exceptions thrown before (same messages, the existing `catch` keep working). All the errors of the bundle can be caught with `ProcessExceptionInterface`, except the exceptions of the Symfony components. Update documentation, add tests. diff --git a/README.md b/README.md index 8c2b601b..65e1ffb4 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ Compatible with [Symfony stable version and latest Long-Term Support (LTS) relea Demo project can be found on [there](https://github.com/cleverage/process-bundle-demo). +## Installation + +```bash +composer require cleverage/process-bundle +``` + +Without Symfony Flex, register the bundle in `config/bundles.php`: + +```php +CleverAge\ProcessBundle\CleverAgeProcessBundle::class => ['all' => true], +``` + +Then define your first process: see the [quick start](docs/01-quick_start.md) (optional dependencies, configuration, commands). + ## Documentation For usage documentation, see: