From 3ed40379cee67578293c7ea4508b118bdd2f2854 Mon Sep 17 00:00:00 2001
From: Aleksandr Yakovlev <vrn.yakovlev.alex@gmail.com>
Date: Sun, 26 Jan 2025 23:07:10 +0300
Subject: [PATCH] Update README.md and README.npm.md

---
 README.md     | 29 ++++++++++++++++++++++++++++-
 README.npm.md | 29 +++++++++++++++++------------
 2 files changed, 45 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index abcd188..e2f24bc 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,6 @@ Transform tree diagrams into real folders and generate folder structure visualiz
 npm install -g foldertree-cli
 ```
 
-## Usage
 ### Creating Folders from Tree Diagram
 
 1. Create a text file (e.g., `structure.txt`) with your desired folder structure:
@@ -50,6 +49,8 @@ Generate a tree diagram from an existing folder
 foldertree-cli generate my-project output.txt
 ```
 
+## ❗To hide system files or to include `.gitignore` rules, [check the section below](#usage-guide).
+
 ### Tree Diagram Format
 
 * Use ├── for items that have siblings below them
@@ -57,3 +58,29 @@ foldertree-cli generate my-project output.txt
 * Use │ for vertical lines
 * Add / at the end of folder names
 * Indent using spaces (4 spaces or 1 tab)
+
+
+## usage-guide
+
+<details> <summary>CLI help</summary>
+
+```
+Usage:
+    foldertree-cli (create-folders|create|c) <input-file> <target-directory>
+    foldertree-cli (generate-file|generate|g) <source-directory> <output-file> [options]
+
+Commands:
+    create-folders, create, c    - Create folder structure from input file
+    generate-file, generate, g   - Generate structure text file from existing directory
+
+Options:
+    --ignore <gitignore-file>   - Specify a .gitignore file to exclude additional paths
+    --include-hidden            - Include hidden and system folders (like .git, .vscode)
+
+Examples:
+    foldertree-cli create-folders ./structure.txt ./my-project
+    foldertree-cli generate-file ./my-project ./output-structure.txt
+    foldertree-cli generate-file ./my-project ./output-structure.txt --ignore ./.gitignore
+    foldertree-cli generate-file ./my-project ./output-structure.txt --include-hidden
+```
+</details>
diff --git a/README.npm.md b/README.npm.md
index 5ba8ccf..c334f4e 100644
--- a/README.npm.md
+++ b/README.npm.md
@@ -36,23 +36,28 @@ foldertree-cli generate my-project output.txt
 └── README.md
 ```
 
-## Commands
-### create
-
-Creates folders and files from a tree diagram:
-
-```bash
-foldertree-cli create <input-file> <target-directory>
+### Usage:
 ```
+Usage:
+    foldertree-cli (create-folders|create|c) <input-file> <target-directory>
+    foldertree-cli (generate-file|generate|g) <source-directory> <output-file> [options]
 
-### generate
+Commands:
+    create-folders, create, c    - Create folder structure from input file
+    generate-file, generate, g   - Generate structure text file from existing directory
 
-Creates a tree diagram from existing folders:
-```bash
-foldertree-cli generate <source-directory> <output-file>
+Options:
+    --ignore <gitignore-file>   - Specify a .gitignore file to exclude additional paths
+    --include-hidden            - Include hidden and system folders (like .git, .vscode)
+
+Examples:
+    foldertree-cli create-folders ./structure.txt ./my-project
+    foldertree-cli generate-file ./my-project ./output-structure.txt
+    foldertree-cli generate-file ./my-project ./output-structure.txt --ignore ./.gitignore
+    foldertree-cli generate-file ./my-project ./output-structure.txt --include-hidden
 ```
 
-Features
+### Features
 * Validates tree diagram format
 * Handles nested structures
 * Creates empty files automatically