add doc for tree command

ksckaan1 · Sep 19, 2024 · 8fe49cb · 8fe49cb
1 parent f96bd54
commit 8fe49cb
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,7 @@ Hexago is a CLI tool for you to create a Go project by applying hexagonal archit
   - [`pkg`](#pkg)
   - [`cmd`](#cmd)
   - [`run`](#run)
+  - [`tree`](#tree)
 - [Templates](#templates)
   - [Custom Templates](#custom-templates)
     - [Naming Custom Template](#naming-custom-template)
@@ -455,6 +456,15 @@ This command can be used for two different purposes. the `run` command create a
   go version go1.23.0 darwin/arm64
   ```
 
+### `tree`
+This command prints hexagonal structure of project.
+
+```sh
+hexago tree
+```
+
+![](./doc/17-tree.gif)
+
 ## Templates
 
 When creating service, application, infrastructure and package with Hexago, templates are used to create go files.  Hexago has 2 built-in templates, `std` and `do`.

diff --git a/doc/17-tree.gif b/doc/17-tree.gif