Skip to content

Commit acbc375

Browse files
committed
Improves documentation
1 parent 01c100d commit acbc375

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,9 @@ Would expect the following .gitattributes file content:
179179
The `--report-stale-export-ignores` option extends the validation to look for export-ignore statements referencing non-existent
180180
repository artifacts. In combination with the `--diff` option these will be shown in the output.
181181

182-
#### Additional commands
182+
### Additional commands
183+
184+
#### Init command
183185

184186
The `init` command will create an initial `.lpv` file with the default patterns used to match common repository artifacts.
185187

@@ -192,7 +194,10 @@ The `--overwrite|-o` option overwrites an existing `.lpv` file.
192194
The `--preset` option allows to choose from a predefined set of glob pattern.
193195
Available presets are `PHP`, `Python`, and `Go`. With `PHP` being the default.
194196

195-
The `tree` command allows you to inspect the __flat__ `source` and `dist package` structure of the given project.
197+
#### Tree command
198+
199+
The `tree` command of the lean package validator allows you to inspect the __flat__ `source` and `dist package` structure
200+
of the given project/micro-package. It requires the [tree](https://en.wikipedia.org/wiki/Tree_(command)) command to be installed.
196201

197202
``` bash
198203
lean-package-validator tree [<directory>] --src

0 commit comments

Comments
 (0)