Improve include documentation

Metadrop · Oct 31, 2024 · c15a23e · c15a23e
1 parent 051568d
commit c15a23e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/.drupal-artifact-builder.yml.dist b/.drupal-artifact-builder.yml.dist
@@ -3,9 +3,14 @@
 repository: [email protected]:example/example-artifact.git
 
 # include
-# Extra files or folders to include into the artifact.
+# List of extra files or folders to include into the artifact.
 include: []
 
+# Example of include with files:
+# include:
+#   - solr
+#   - oauth
+
 # author
 # It will be the author used in git commits.
 # author: John Doe <[email protected]>

diff --git a/README.md b/README.md
@@ -34,7 +34,9 @@ cp vendor/metadrop/drupal-artifact-builder/.drupal-artifact-builder.yml.dist .dr
 
     Example:
     ```yaml
-    include: []
+    include:
+      - oauth
+      - solr
     ```
 
 - **author**: It will be the author used in git commits.