diff --git a/README.md b/README.md index 2742588..2c4dafb 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,14 @@ It allows for: * [Behat/Symfony2Extension differences](docs/04_bs2e_differences.md) * [Configuration reference](docs/05_configuration_reference.md) +## Versioning + +This package follows [semantic versioning](https://semver.org/) - public API is defined as configuration and behaviour +defined in form of testable scenarios in the [`features`](features) directory. This means once your application is +configured to use Behat with SymfonyExtension, it shall continue to work flawlessly within the same major version. +PHP classes, apart from `FriendsOfBehat\SymfonyExtension\Bundle\FriendsOfBehatSymfonyExtensionBundle`, are not covered +by this backwards compatibility promise. + ## License This extension is completely free and released under permissive [MIT license](LICENSE). @@ -29,4 +37,4 @@ This extension is completely free and released under permissive [MIT license](LI ## Authors It is originally created by [Kamil Kokot](https://github.com/pamil). -See the list of [all contributors](https://github.com/FriendsOfBehat/SymfonyExtension/graphs/contributors). +See the list of [all contributors](https://github.com/FriendsOfBehat/SymfonyExtension/graphs/contributors). diff --git a/docs/01_installation.md b/docs/01_installation.md index 053d36a..267f06a 100644 --- a/docs/01_installation.md +++ b/docs/01_installation.md @@ -1,5 +1,8 @@ ## Installation +If you're starting a new project, we recommend to use Symfony 4 with Flex as it's the most straightforward way. +If you're adding this extension to an existing project, pick the method that fits it the best. + ### Symfony 4 (with Flex) 1. Require this extension using *Composer* and allow for using contrib recipes: @@ -8,7 +11,7 @@ composer require --dev friends-of-behat/symfony-extension:^2.0 ``` -### Symfony 4 (without Flex) +### Symfony 4 (new directory structure, without Flex) 1. Require this extension using *Composer*: diff --git a/docs/03_mink_integration.md b/docs/03_mink_integration.md index 84a2dd4..f60724e 100644 --- a/docs/03_mink_integration.md +++ b/docs/03_mink_integration.md @@ -33,10 +33,3 @@ This integration provides two services to use inside Symfony container: * **`behat.mink.parameters`** (autoconfigured by `$minkParameters`) - an array (`\ArrayAccess` object) containing the configuration parameters of `MinkExtension` - -### Caveats - -This driver behaviour differs from the one provided with [`Behat/Symfony2Extension`](https://github.com/Behat/Symfony2Extension), -as it uses an isolated application kernel instance, so that services state changes within your contexts does not affect -the driver results. With that limitation, changing the driver to a different one is seamless. For more information, look -at [this issue](https://github.com/Behat/Symfony2Extension/issues/112).