Skip to content

Commit 036090f

Browse files
Github wiki!
1 parent 7482e6d commit 036090f

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@
2020
> This lib was developed just for fun, and has not been thoroughly tested!
2121
> May not be suitable for production code 😊
2222
23+
> [!IMPORTANT]
24+
> Complete documentation available in [wiki](https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/wiki).
25+
2326
<p align="center">
2427
<img src="https://github.com/ComputerDaddyGuy/JFileTreePrettyPrinter/blob/develop/assets/basic_usage.jpg?raw=true" alt="JFileTreePrettyPrint basic usage"/>
2528
</p>

ROADMAP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818
- [x] Ordering
1919

2020
## To do
21+
- [x] Use Github wiki to document options instead of readme
2122
- [ ] Additional text on lines
2223
- [ ] Option: Filename decorator
2324

2425
## Backlog
25-
- [ ] Use Github wiki to document options instead of readme
2626
- [ ] Option: custom tree format
2727
- [ ] Option: custom emojis
2828
- [ ] Option: color

release_process.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@
2020
- Create new release based on `vX.Y.Z` tag: copy content of `CHANGELOG.md` for this version
2121
- Github `release` workflow will run automatically
2222
- Few minutes later, artifact is available on Maven Central 🎉
23+
- Update wiki if required
2324

2425
- **Merge `main` back into `develop` branch**
2526
- Note: `pom.xml` now has `X.Y.(Z+1)-SNAPSHOT` version

0 commit comments

Comments
 (0)