docs(readme): correct readme source

Author: ahmadnassri

README.md

@@ -10,44 +10,50 @@ wait for all `workflow_run` required workflows to be successful
 
 <details>
   <summary><strong>Why?</strong></summary>
-  
-  The [`workflow_run`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run) event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.
 
-  ###### example
-  ```yaml
-  on:
-  workflow_run:
-    workflows: [ test ]
-    types: 
-      - completed
-  ```
+The [`workflow_run`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run) event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.
+
+###### example
+
+``` yaml
+on:
+workflow_run:
+  workflows: [ test ]
+  types: 
+    - completed
+```
+
+However by itself, this doesn't quite work as expected.
+
+1.  The `completed` type, does not indicate success, for that you'd have to include the following in each job of your workflow:
+
+    ``` yaml
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    ```
+
+2.  If you're depending on more than one workflow, then ANY of them completing, will trigger the event
+
+    ###### example
 
-  However by itself, this doesn't quite work as expected.
+    ``` yaml
+    name: deploy
 
-  1. The `completed` type, does not indicate success, for that you'd have to include the following in each job of your workflow:
-      ```yaml
-      if: ${{ github.event.workflow_run.conclusion == 'success' }}
-      ```
+    on:
+    workflow_run:
+      workflows: [ test, lint, compile ]
+      types: 
+        - completed
+    ```
 
-  2. If you're depending on more than one workflow, then ANY of them completing, will trigger the event
-      ###### example
-      ```yaml
-      name: deploy
+    > *if your `test` workflow fails, but `lint` completed successfully, `github.event.workflow_run.conclusion == 'success'` will still be true*
 
-      on:
-      workflow_run:
-        workflows: [ test, lint, compile ]
-        types: 
-          - completed
-      ```
-      > _if your `test` workflow fails, but `lint` completed successfully, `github.event.workflow_run.conclusion == 'success'` will still be true_
+3.  Your workflow will trigger as many times as you have workflow dependencies
 
-  3. Your workflow will trigger as many times as you have workflow dependencies
-      > _in the previous example, our `deploy` workflow, will run 3 times!_
+    > *in the previous example, our `deploy` workflow, will run 3 times!*
 
-  All this makes the `workflow_run` event fundamentally broken for any advanced usage, this Action aims to remedy that.
+All this makes the `workflow_run` event fundamentally broken for any advanced usage, this Action aims to remedy that.
 
-  > _**Note**: See this [Community discussion](https://github.community/t/workflow-run-completed-event-triggered-by-failed-workflow/128001/5) for more info on the topic_
+> ***Note**: See this [Community discussion](https://github.community/t/workflow-run-completed-event-triggered-by-failed-workflow/128001/5) for more info on the topic*
 
 </details>
 

docs/README.md

@@ -1,3 +1,46 @@
+<details>
+  <summary><strong>Why?</strong></summary>
+  
+  The [`workflow_run`](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#workflow_run) event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.
+
+  ###### example
+  ```yaml
+  on:
+  workflow_run:
+    workflows: [ test ]
+    types: 
+      - completed
+  ```
+
+  However by itself, this doesn't quite work as expected.
+
+  1. The `completed` type, does not indicate success, for that you'd have to include the following in each job of your workflow:
+      ```yaml
+      if: ${{ github.event.workflow_run.conclusion == 'success' }}
+      ```
+
+  2. If you're depending on more than one workflow, then ANY of them completing, will trigger the event
+      ###### example
+      ```yaml
+      name: deploy
+
+      on:
+      workflow_run:
+        workflows: [ test, lint, compile ]
+        types: 
+          - completed
+      ```
+      > _if your `test` workflow fails, but `lint` completed successfully, `github.event.workflow_run.conclusion == 'success'` will still be true_
+
+  3. Your workflow will trigger as many times as you have workflow dependencies
+      > _in the previous example, our `deploy` workflow, will run 3 times!_
+
+  All this makes the `workflow_run` event fundamentally broken for any advanced usage, this Action aims to remedy that.
+
+  > _**Note**: See this [Community discussion](https://github.community/t/workflow-run-completed-event-triggered-by-failed-workflow/128001/5) for more info on the topic_
+
+</details>
+
 ## Usage
 
 ```yaml