Skip to content

Commit 52b9147

Browse files
author
Manuel Spagnolo
committed
Fixing Readme
1 parent 95d5234 commit 52b9147

File tree

1 file changed

+17
-23
lines changed

1 file changed

+17
-23
lines changed

README.md

Lines changed: 17 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,17 @@ representation of your project to your documentation.
1313
Run
1414

1515
```
16-
npm install directree -g
16+
npm install directree -g
1717
```
1818

1919
## Usage ##
20-
It takes the following parameters:
2120

22-
- `path`
21+
```
22+
directree [options] <path>
23+
```
24+
25+
It takes the following options:
26+
2327
- `show-files`
2428
- `log-level`
2529
- `ignore-pattern`
@@ -32,10 +36,7 @@ It's the path of the folder you want to show as a tree. It's required.
3236
#### Example ####
3337

3438
```
35-
directree -p ./
36-
```
37-
```
38-
directree --path ./
39+
directree .
3940
```
4041

4142
### Show Files ###
@@ -45,10 +46,10 @@ Add this flag if you want to show files in the tree.
4546
#### Example ####
4647

4748
```
48-
directree --path ./ -f
49+
directree -f .
4950
```
5051
```
51-
directree --path ./ --show-files
52+
directree --show-files .
5253
```
5354

5455
### Logging level ###
@@ -59,10 +60,10 @@ The default level is `3` (only errors), the deepest and most verbose level of lo
5960
#### Example ####
6061

6162
```
62-
directree --path ./ -f -l 0
63+
directree -l 2 .
6364
```
6465
```
65-
directree --path ./ --log-level 2
66+
directree --log-level 2 .
6667
```
6768

6869
### Ignore pattern ###
@@ -73,10 +74,10 @@ It runs `minimatch` under the hood, thus it takes a glob as argument.
7374
#### Example ####
7475

7576
```
76-
directree --path . -f -i node_modules
77+
directree -i node_modules/**/*.js .
7778
```
7879
```
79-
directree --path . --ignore-pattern **/*.js
80+
directree --ignore-pattern node_modules/**/*.js .
8081
```
8182

8283
### Output ###
@@ -88,10 +89,10 @@ _Please note: this is an async feature, so keep that in mind in case of programm
8889
#### Example ####
8990

9091
```
91-
directree --path . -f -o ./tree.txt
92+
directree -f -o ./tree.txt .
9293
```
9394
```
94-
directree --path . --output ./tree.txt
95+
directree --output ./tree.txt .
9596
```
9697

9798
## Programmatic usage ##
@@ -126,11 +127,4 @@ Thus the parameters object looks like:
126127

127128
## Contributing
128129

129-
You can contribute to this project: clone the repo, write your wonderful code and before pull-requesting please run:
130-
131-
```
132-
npm test
133-
npm run lint
134-
```
135-
136-
Only linted and tested requests will be accepted.
130+
Contributors are well welcomed! Please do not skip git hooks when you submit Pull Requests :D

0 commit comments

Comments
 (0)