Skip to content

Commit 275c323

Browse files
w2xiw2xi
committed
docs: update README.md
1 parent 573521c commit 275c323

1 file changed

Lines changed: 87 additions & 38 deletions

File tree

‎README.md‎

Lines changed: 87 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -35,67 +35,116 @@ Ignore `.git` and `node_modules` directory.
3535

3636
```bash
3737
$ treei -i '.git|node_modules' # or treei -i '.git,node_modules'
38-
treei
39-
├──📄.editorconfig
40-
├──📄.eslintrc.js
41-
├──📄.gitignore
42-
├──📄.prettierrc.js
43-
├──📄CHANGELOG.md
44-
├──📄LICENSE
45-
├──📄package-lock.json
46-
├──📄package.json
47-
├──📄README.md
48-
└──📁src
49-
├──📄config.js
50-
├──📄generate.js
51-
├──📄index.js
52-
├──📄toTree.js
53-
└──📄utils.js
38+
├──.github
39+
| └──workflows
40+
| | ├──release.yml
41+
| | └──test.yml
42+
├──.vscode
43+
| └──settings.json
44+
├──dist
45+
| └──index.js
46+
├──src
47+
| ├──config.ts
48+
| ├──generate.ts
49+
| ├──handleOptions.ts
50+
| ├──index.ts
51+
| ├──sort.ts
52+
| ├──toTree.ts
53+
| ├──type.ts
54+
| └──utils.ts
55+
├──test
56+
| ├──handleOptions.spec.ts
57+
| ├──sort.spec.ts
58+
| └──toTree.spec.ts
59+
├──.editorconfig
60+
├──.eslintrc
61+
├──.gitignore
62+
├──.prettierignore
63+
├──.prettierrc.mjs
64+
├──CHANGELOG.md
65+
├──LICENSE
66+
├──package.json
67+
├──pnpm-lock.yaml
68+
├──README.md
69+
└──tsconfig.json
5470
```
5571

5672
Show emoji icon, prefixing filename or directory.
5773

5874
```bash
5975
$ treei -i '.git,node_modules' --icon
60-
treei
76+
├──📁.github
77+
| └──📁workflows
78+
| | ├──📄release.yml
79+
| | └──📄test.yml
80+
├──📁.vscode
81+
| └──📄settings.json
82+
├──📁dist
83+
| └──📄index.js
84+
├──📁src
85+
| ├──📄config.ts
86+
| ├──📄generate.ts
87+
| ├──📄handleOptions.ts
88+
| ├──📄index.ts
89+
| ├──📄sort.ts
90+
| ├──📄toTree.ts
91+
| ├──📄type.ts
92+
| └──📄utils.ts
93+
├──📁test
94+
| ├──📄handleOptions.spec.ts
95+
| ├──📄sort.spec.ts
96+
| └──📄toTree.spec.ts
6197
├──📄.editorconfig
62-
├──📄.eslintrc.js
98+
├──📄.eslintrc
6399
├──📄.gitignore
64-
├──📄.prettierrc.js
100+
├──📄.prettierignore
101+
├──📄.prettierrc.mjs
65102
├──📄CHANGELOG.md
66103
├──📄LICENSE
67-
├──📄package-lock.json
68104
├──📄package.json
105+
├──📄pnpm-lock.yaml
69106
├──📄README.md
70-
└──📁src
71-
├──📄config.js
72-
├──📄generate.js
73-
├──📄index.js
74-
├──📄toTree.js
75-
└──📄utils.js
107+
└──📄tsconfig.json
76108
```
77109

78110
Export output into `result.md`, and append mode by default.
79111

80112
```bash
81-
$ treei -i '.git,node_modules' -o result.md
82-
treei
113+
$ treei -i '.git,node_modules' --icon -o result.md
114+
├──📁.github
115+
| └──📁workflows
116+
| | ├──📄release.yml
117+
| | └──📄test.yml
118+
├──📁.vscode
119+
| └──📄settings.json
120+
├──📁dist
121+
| └──📄index.js
122+
├──📁src
123+
| ├──📄config.ts
124+
| ├──📄generate.ts
125+
| ├──📄handleOptions.ts
126+
| ├──📄index.ts
127+
| ├──📄sort.ts
128+
| ├──📄toTree.ts
129+
| ├──📄type.ts
130+
| └──📄utils.ts
131+
├──📁test
132+
| ├──📄handleOptions.spec.ts
133+
| ├──📄sort.spec.ts
134+
| └──📄toTree.spec.ts
83135
├──📄.editorconfig
84-
├──📄.eslintrc.js
136+
├──📄.eslintrc
85137
├──📄.gitignore
86-
├──📄.prettierrc.js
138+
├──📄.prettierignore
139+
├──📄.prettierrc.mjs
87140
├──📄CHANGELOG.md
88141
├──📄LICENSE
89-
├──📄package-lock.json
90142
├──📄package.json
143+
├──📄pnpm-lock.yaml
91144
├──📄README.md
92-
└──📁src
93-
├──📄config.js
94-
├──📄generate.js
95-
├──📄index.js
96-
├──📄toTree.js
97-
└──📄utils.js
145+
└──📄tsconfig.json
98146
```
147+
99148
## License
100149

101-
[MIT](./LICENSE)
150+
[MIT](./LICENSE)

0 commit comments

Comments
 (0)