Skip to content

Commit

Permalink
Merge pull request #32 from MacPaw/fix/updateReadMe
Browse files Browse the repository at this point in the history
feat: update readme
  • Loading branch information
Yozhef authored Jan 17, 2022
2 parents f8bf6d1 + 21a6753 commit fd47eff
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 3 deletions.
44 changes: 42 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,54 @@ Behat Messenger Context Bundle
Installation
============

Step 1: Install Bundle
Step 1: Download the Bundle
----------------------------------
Open a command console, enter your project directory and execute:

### Applications that use Symfony Flex [in progress](https://github.com/MacPaw/BehatRedisContext/issues/2)

```console
$ composer require --dev macpaw/behat-messenger-context
```

### Applications that don't use Symfony Flex

Open a command console, enter your project directory and execute the
following command to download the latest stable version of this bundle:

```console
$ composer require --dev macpaw/behat-messenger-context
```

This command requires you to have Composer installed globally, as explained
in the [installation chapter](https://getcomposer.org/doc/00-intro.md)
of the Composer documentation.


Then, enable the bundle by adding it to the list of registered bundles
in the `app/AppKernel.php` file of your project:

```php
<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
public function registerBundles()
{
$bundles = array(
// ...
BehatMessengerContext\BehatMessengerContextBundle::class => ['test' => true],
);

// ...
}

// ...
}
```

Step 2: Configure Messenger
=============
Copying `config/packages/dev/messenger.yaml` and pasting that into `config/packages/test/`. This gives us messenger configuration that will only be used in the test environment. Uncomment the code, and replace sync with in-memory. Do that for both of the transports.
Expand Down Expand Up @@ -50,4 +90,4 @@ Go to `behat.yml`
[master Code Coverage]: https://codecov.io/gh/macpaw/BehatMessengerContext/branch/master
[master Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/master?logo=codecov
[develop Code Coverage]: https://codecov.io/gh/macpaw/BehatMessengerContext/branch/develop
[develop Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/develop?logo=codecov
[develop Code Coverage Image]: https://img.shields.io/codecov/c/github/macpaw/BehatMessengerContext/develop?logo=codecov
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
## Supported Versions

| Version | Supported |
| ------- | ------------------ |
|---------| ------------------ |
| 0.x.x | :white_check_mark: |
| 1.x.x | :white_check_mark: |
| 2.x.x | :white_check_mark: |

## Reporting a Bug

Expand Down

0 comments on commit fd47eff

Please sign in to comment.