Update README.md

tj-actions · Feb 24, 2024 · fb286e0 · fb286e0
1 parent e8fb88d
commit fb286e0
Showing 1 changed file with 8 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -64,12 +64,11 @@ Add any of the supported headings as a [`H2` header](https://github.com/adam-p/m
 
 `README.md`
 
-```
-…
-
-## Inputs
-— A placeholder would be added here automatically — 
+> [!NOTE]
+> Add any of the headings you want to generate the documentation for (this can be multiple headings supported by the input file)
 
+```
+## Inputs 
 ```
 
 Update your workflow
@@ -82,6 +81,8 @@ Update your workflow
         uses: tj-actions/auto-doc@v3
 ```
 
+**👇 This was generated 👇 using 👉: [action.yml](./action.yml)**
+
 ## Inputs
 
 <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
@@ -179,7 +180,7 @@ Update your workflow
 
 <!-- AUTO-DOC-INPUT:END -->
 
-**👆 This is generated 👆 using :point\_right: [action.yml](./action.yml)**
+**👆 This was generated 👆 using 👉 [action.yml](./action.yml)**
 
 ## Example workflow
 
@@ -247,7 +248,7 @@ choco install auto-doc
 
 ### Synopsis
 
-Automatically generate documentation for your custom github action or reusable workflow.
+Automatically generate documentation for your custom GitHub action or reusable workflow.
 
     auto-doc [flags]