Merge pull request #12 from frontkom/eiriksm-patch-1

Add some docs
frontkom · Nov 6, 2024 · e03e9c7 · e03e9c7
2 parents a031e40 + f7c7c0b
commit e03e9c7
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,22 @@
 # drupal-behat-definitions
 Useful Behat things we use for Drupal
+
+[![Test](https://github.com/frontkom/drupal-behat-definitions/actions/workflows/run-tests.yml/badge.svg)](https://github.com/frontkom/drupal-behat-definitions/actions/workflows/run-tests.yml)
+[![Packagist Downloads](https://img.shields.io/packagist/dt/frontkom/drupal-behat-definitions)](https://packagist.org/packages/frontkom/drupal-behat-definitions)
+
+
+## Installation
+
+```bash
+composer require --dev frontkom/drupal-behat-definitions
+```
+
+Then you would probably include the contexts you are interested in, inside of your `behat.yml` file. Here is one example of including the Drupal Gutenberg Context:
+
+```diff
+       contexts:
++        - Frontkom\DrupalBehatDefinitions\DrupalGutenbergContext
+         - Drupal\DrupalExtension\Context\MinkContext
+         - Drupal\DrupalExtension\Context\MarkupContext
+         - Drupal\DrupalExtension\Context\MessageContext
+```