From 399a2b38f3f5df36108837193affeedfc3d945e0 Mon Sep 17 00:00:00 2001
From: jaedle <dennis.jekubczyk@gmail.com>
Date: Sun, 24 Feb 2019 11:52:31 +0100
Subject: [PATCH] add documentation for details

---
 docs/usage.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/docs/usage.md b/docs/usage.md
index 29f55ed2..55c2cf8f 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -542,6 +542,34 @@ would print the following output:
 * test:    Run all the go tests.
 ```
 
+## Detailed task description
+
+Running `task --details task-name` will show a detailed description of a task if present.
+The following Taskfile:
+
+```yaml
+version: '2'
+
+tasks:
+  release:
+    details: |
+      Release your project to github
+
+      Please make sure that you have set GITHUB_TOKEN before starting.
+    cmds:
+      - your-release-tool
+```
+
+with running ``task --details release`` would print the following output:
+
+```
+Release your project to github
+
+Please make sure that you have set GITHUB_TOKEN before starting
+```
+
+*showing the detailed description will not execute the command*
+
 ## Silent mode
 
 Silent mode disables echoing of commands before Task runs it.