Better readme

Author: ComputerDaddyGuy

README.md

@@ -10,25 +10,28 @@
 [![Apache License 2.0](https://img.shields.io/:license-Apache%20License%202.0-blue.svg)](https://github.com/computerdaddyguy/jfiletreeprettyprinter/blob/main/LICENSE)
 
 **A lightweight Java library for printing directory structures in a clean, tree-like format.**
-- Sorting & filtering
+
+Supports various [options](#options) to customize the directories scanning and rendering:
+- Filtering & sorting
 - Emoji support 🎉
 - Limit displayed children (fixed value or dynamically)
+- Custom line extension (comment, file details, etc.)
 - Compact directory chains
 - Maximum depth
-- Custom line extension (comment, file details, etc.)
 - Various styles for tree rendering
 
+<p align="center">
+	JFileTreePrettyPrint project structure, pretty printed using JFileTreePrettyPrint (see <a href="https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/blob/develop/src/example/java/io/github/computerdaddyguy/jfiletreeprettyprinter/example/CompleteExample.java">CompleteExample.java</a>)
+	<img src="https://raw.githubusercontent.com/ComputerDaddyGuy/JFileTreePrettyPrinter/refs/heads/develop/assets/project-structure.png" alt="JFileTreePrettyPrint project structure, using JFileTreePrettyPrint"/>
+</p>
+
 > [!CAUTION]
 > This lib was developed just for fun, and has not been thoroughly tested!  
 > May not be suitable for production code 😊
 
 > [!IMPORTANT]
 > Complete documentation available in [wiki](https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/wiki).
 
-<p align="center">
-	<img src="https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/blob/develop/assets/JfileTreePrettyPrinter-structure.png?raw=true" alt="JFileTreePrettyPrint structure, using JFileTreePrettyPrint"/>
-</p>
-
 * [Import dependency](#import-dependency)
 * [Usage](#usage)  
 * [Options](#options)
@@ -84,38 +87,73 @@ base/
 
 # Options
 
-* [Tree format](#tree-format)
+* [Filtering](#filtering)
+* [Sorting](#sorting)
 * [Emojis ❤️](#emojis-%EF%B8%8F)
 * [Child limit](#child-limit)
+* [Line extension](#line-extension)
 * [Compact directories](#compact-directories)
 * [Max depth](#max-depth)
-* [Sorting](#sorting)
-* [Filtering](#filtering)
-* [Line extension](#line-extension)
+* [Tree format](#tree-format)
 
-## Tree format
-Choose between different tree formats.
-The default is `UNICODE_BOX_DRAWING`, supported by all terminals, but you can also switch to use `CLASSIC_ASCII`.
+## Filtering
+Files and directories can be selectively included or excluded using a custom `PathMatcher`.
+
+Filtering is independant for files & directories. Files are filtered only if their parent directory pass the directory filter.
+If none of some directory's children match, the directory is still displayed.
+
+The `PathMatchers` class provides several ready-to-use methods for creating and combining common matchers.
 
 ```java
-// Example: FileTreeFormat.java
+// Example: Filtering.java
+var excludeDirWithNoJavaFiles = PathMatchers.not(PathMatchers.hasNameEndingWith("no_java_file"));
+var hasJavaExtension = PathMatchers.hasExtension("java");
+
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII))
-    .build();
+	.customizeOptions(
+		options -> options
+			.filterDirectories(excludeDirWithNoJavaFiles)
+			.filterFiles(hasJavaExtension)
+	)
+	.build();
 ```
-
 ```
-tree_format/
-|-- file_1
-|-- file_2
-`-- subFolder/
-    |-- subFile_1
-    `-- subFile_2
+filtering/
+├─ dir_with_java_files/
+│  ├─ file_B.java
+│  └─ file_E.java
+├─ dir_with_nested_java_files/
+│  └─ nested_dir_with_java_files/
+│     ├─ file_G.java
+│     └─ file_J.java
+└─ file_A.java
 ```
 
-> [!TIP]
-> *Idea for a future version: option to allow usage of custom format*
+## Sorting
+Files and directories can be sorted using a custom comparator (default is alphabetical order).
+If the provided comparator considers two paths equal (i.e., returns `0`), an alphabetical comparator is applied as a tie-breaker to ensure consistent results across all systems.  
+
+The `PrettyPrintOptions.Sorts` class provides a set of basic, ready-to-use comparators.
 
+```java
+// Example: Sorting.java
+var prettyPrinter = FileTreePrettyPrinter.builder()
+    .customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
+    .build();
+```
+```
+sorting/
+├─ c_dir/
+│  └─ c_file
+├─ d_dir/
+│  ├─ d_b_dir/
+│  │  └─ d_b_file
+│  └─ d_a_file
+├─ a_file
+├─ b_file
+├─ x_file
+└─ y_file
+```
 
 ## Emojis ❤️
 If your terminal supports them, you can choose to use emojis.
@@ -207,6 +245,52 @@ child_limit_dynamic/
 > [!TIP]
 > *Idea for a future version: helper for custom basic functions (by name, prefix, regex, etc.)*
 
+
+## Line extension
+You can extend each displayed path with additional information by providing a custom `Function<Path, String>`.
+This is useful to annotate your tree with comments, display file sizes, or add domain-specific notes.
+
+The function receives the current path and returns an optional string to append.
+If the function returns `null`, nothing is added.
+
+```java
+// Example: LineExtension.java
+var printedPath = Path.of("src/example/resources/line_extension");
+
+Function<Path, String> lineExtension = path -> {
+	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/api", printedPath).matches(path)) {
+		return "\t\t\t// All API code: controllers, etc.";
+	}
+	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/domain", printedPath).matches(path)) {
+		return "\t\t\t// All domain code: value objects, etc.";
+	}
+	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/infra", printedPath).matches(path)) {
+		return "\t\t\t// All infra code: database, email service, etc.";
+	}
+	if (PathMatchers.hasNameMatchingGlob("*.properties").matches(path)) {
+		return "\t// Config file";
+	}
+	return null;
+};
+var prettyPrinter = FileTreePrettyPrinter.builder()
+	.customizeOptions(options -> options.withLineExtension(lineExtension))
+	.build();
+```
+```
+line_extension/
+└─ src/
+   └─ main/
+      ├─ java/
+      │  ├─ api/			// All API code: controllers, etc.
+      │  │  └─ Controller.java
+      │  ├─ domain/			// All domain code: value objects, etc.
+      │  │  └─ ValueObject.java
+      │  └─ infra/			// All infra code: database, email service, etc.
+      │     └─ Repository.java
+      └─ resources/
+         └─ application.properties	// Config file
+```
+
 ## Compact directories
 Directories chain with single directory child are fully expanded by default, but you can compact them into a single tree entry.
 
@@ -247,109 +331,28 @@ max_depth/
          └─ ... (max depth reached)
 ```
 
-## Sorting
-Files and directories can be sorted using a custom comparator (default is alphabetical order).
-If the provided comparator considers two paths equal (i.e., returns `0`), an alphabetical comparator is applied as a tie-breaker to ensure consistent results across all systems.  
-
-The `PrettyPrintOptions.Sorts` class provides a set of basic, ready-to-use comparators.
+## Tree format
+Choose between different tree formats.
+The default is `UNICODE_BOX_DRAWING`, supported by all terminals, but you can also switch to use `CLASSIC_ASCII`.
 
 ```java
-// Example: Sorting.java
+// Example: FileTreeFormat.java
 var prettyPrinter = FileTreePrettyPrinter.builder()
-    .customizeOptions(options -> options.sort(PrettyPrintOptions.Sorts.DIRECTORY_FIRST))
+    .customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII))
     .build();
 ```
-```
-sorting/
-├─ c_dir/
-│  └─ c_file
-├─ d_dir/
-│  ├─ d_b_dir/
-│  │  └─ d_b_file
-│  └─ d_a_file
-├─ a_file
-├─ b_file
-├─ x_file
-└─ y_file
-```
-
-## Filtering
-Files and directories can be selectively included or excluded using a custom `PathMatcher`.
 
-Filtering is independant for files & directories. Files are filtered only if their parent directory pass the directory filter.
-If none of some directory's children match, the directory is still displayed.
-
-The `PathMatchers` class provides several ready-to-use methods for creating and combining common matchers.
-
-```java
-// Example: Filtering.java
-var excludeDirWithNoJavaFiles = PathMatchers.not(PathMatchers.hasNameEndingWith("no_java_file"));
-var hasJavaExtension = PathMatchers.hasExtension("java");
-
-var prettyPrinter = FileTreePrettyPrinter.builder()
-	.customizeOptions(
-		options -> options
-			.filterDirectories(excludeDirWithNoJavaFiles)
-			.filterFiles(hasJavaExtension)
-	)
-	.build();
-```
 ```
-filtering/
-├─ dir_with_java_files/
-│  ├─ file_B.java
-│  └─ file_E.java
-├─ dir_with_nested_java_files/
-│  └─ nested_dir_with_java_files/
-│     ├─ file_G.java
-│     └─ file_J.java
-└─ file_A.java
+tree_format/
+|-- file_1
+|-- file_2
+`-- subFolder/
+    |-- subFile_1
+    `-- subFile_2
 ```
 
-## Line extension
-You can extend each displayed path with additional information by providing a custom `Function<Path, String>`.
-This is useful to annotate your tree with comments, display file sizes, or add domain-specific notes.
-
-The function receives the current path and returns an optional string to append.
-If the function returns `null`, nothing is added.
-
-```java
-// Example: LineExtension.java
-var printedPath = Path.of("src/example/resources/line_extension");
-
-Function<Path, String> lineExtension = path -> {
-	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/api", printedPath).matches(path)) {
-		return "\t\t\t// All API code: controllers, etc.";
-	}
-	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/domain", printedPath).matches(path)) {
-		return "\t\t\t// All domain code: value objects, etc.";
-	}
-	if (PathMatchers.hasRelativePathMatchingGlob("src/main/java/infra", printedPath).matches(path)) {
-		return "\t\t\t// All infra code: database, email service, etc.";
-	}
-	if (PathMatchers.hasNameMatchingGlob("*.properties").matches(path)) {
-		return "\t// Config file";
-	}
-	return null;
-};
-var prettyPrinter = FileTreePrettyPrinter.builder()
-	.customizeOptions(options -> options.withLineExtension(lineExtension))
-	.build();
-```
-```
-line_extension/
-└─ src/
-   └─ main/
-      ├─ java/
-      │  ├─ api/			// All API code: controllers, etc.
-      │  │  └─ Controller.java
-      │  ├─ domain/			// All domain code: value objects, etc.
-      │  │  └─ ValueObject.java
-      │  └─ infra/			// All infra code: database, email service, etc.
-      │     └─ Repository.java
-      └─ resources/
-         └─ application.properties	// Config file
-```
+> [!TIP]
+> *Idea for a future version: option to allow usage of custom format*
 
 # Changelog
 See [CHANGELOG.md](CHANGELOG.md) for released versions.

assets/JfileTreePrettyPrinter-structure.png

@@ -38,7 +38,7 @@ public static void main(String[] args) {
 			.build();
 
 		Function<Path, String> lineExtension = path -> {
-			if (PathMatchers.hasName("JfileTreePrettyPrinter-structure.png").matches(path)) {
+			if (PathMatchers.hasName("project-structure.png").matches(path)) {
 				return "\t// This image";
 			} else if (PathMatchers.hasName("FileTreePrettyPrinter.java").matches(path)) {
 				return "\t// Main entry point";