Skip to content

Commit 13db0e5

Browse files
Various readme fixes
1 parent f649377 commit 13db0e5

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

README.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
11
# JFileTreePrettyPrint
22

33
A lightweight Java library for printing directory structures in a clean, tree-like format.
4-
5-
- Print folder trees like Unix `tree`
6-
- Customizable:
7-
- ASCII or Unicode styles for tree rendering
8-
- Emoji support 🎉
9-
- Limit displayed children (fixed value or dynamically)
10-
- Compact directory chains
11-
- Maximum depth
4+
- Various styles for tree rendering
5+
- Emoji support 🎉
6+
- Limit displayed children (fixed value or dynamically)
7+
- Compact directory chains
8+
- Maximum depth
129

1310
> [!CAUTION]
1411
> This lib was developed just for fun, and has not been thoroughly tested!
1512
> May not be suitable for production code 😊
1613
1714
<p align="center">
18-
![JFileTreePrettyPrint basic usage](./assets/basic_usage.jpg)
15+
<img src="https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/blob/develop/assets/basic_usage.jpg?raw=true" alt="JFileTreePrettyPrint basic usage"/>
1916
</p>
2017

2118
* [Usage](#usage)
@@ -84,7 +81,7 @@ The default is `UNICODE_BOX_DRAWING`, supported by all terminals, but you can al
8481
```java
8582
// Example: FileTreeFormat.java
8683
var prettyPrinter = FileTreePrettyPrinter.builder()
87-
.customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII)) // UNICODE_BOX_DRAWING (default) or CLASSIC_ASCII
84+
.customizeOptions(options -> options.withTreeFormat(TreeFormat.CLASSIC_ASCII))
8885
.build();
8986
```
9087

@@ -143,7 +140,7 @@ var prettyPrinter = FileTreePrettyPrinter.builder()
143140
```
144141

145142
```
146-
static_children_limit/
143+
children_limit_static/
147144
├─ file_0_1
148145
├─ folder_1/
149146
│ ├─ file_1_1

0 commit comments

Comments
 (0)