Skip to content

Commit 546907a

Browse files
committed
docs: update README
1 parent dc8a4ef commit 546907a

File tree

4 files changed

+83
-9
lines changed

4 files changed

+83
-9
lines changed

.DS_Store

-6 KB
Binary file not shown.

.gitignore

Lines changed: 77 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,34 @@
11

2-
# Created by https://www.gitignore.io/api/node
3-
# Edit at https://www.gitignore.io/?templates=node
2+
# Created by https://www.toptal.com/developers/gitignore/api/node,macos,windows
3+
# Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,windows
4+
5+
### macOS ###
6+
# General
7+
.DS_Store
8+
.AppleDouble
9+
.LSOverride
10+
11+
# Icon must end with two \r
12+
Icon
13+
14+
# Thumbnails
15+
._*
16+
17+
# Files that might appear in the root of a volume
18+
.DocumentRevisions-V100
19+
.fseventsd
20+
.Spotlight-V100
21+
.TemporaryItems
22+
.Trashes
23+
.VolumeIcon.icns
24+
.com.apple.timemachine.donotpresent
25+
26+
# Directories potentially created on remote AFP share
27+
.AppleDB
28+
.AppleDesktop
29+
Network Trash Folder
30+
Temporary Items
31+
.apdisk
432

533
### Node ###
634
# Logs
@@ -58,6 +86,12 @@ typings/
5886
# Optional eslint cache
5987
.eslintcache
6088

89+
# Microbundle cache
90+
.rpt2_cache/
91+
.rts2_cache_cjs/
92+
.rts2_cache_es/
93+
.rts2_cache_umd/
94+
6195
# Optional REPL history
6296
.node_repl_history
6397

@@ -74,14 +108,18 @@ typings/
74108
# parcel-bundler cache (https://parceljs.org/)
75109
.cache
76110

77-
# next.js build output
111+
# Next.js build output
78112
.next
79113

80-
# nuxt.js build output
114+
# Nuxt.js build / generate output
81115
.nuxt
116+
dist
82117

83-
# react / gatsby
84-
dist/
118+
# Gatsby files
119+
.cache/
120+
# Comment in the public line in if your project uses Gatsby and not Next.js
121+
# https://nextjs.org/blog/next-9-1#public-directory-support
122+
# public
85123

86124
# vuepress build output
87125
.vuepress/dist
@@ -95,4 +133,36 @@ dist/
95133
# DynamoDB Local files
96134
.dynamodb/
97135

98-
# End of https://www.gitignore.io/api/node
136+
# TernJS port file
137+
.tern-port
138+
139+
# Stores VSCode versions used for testing VSCode extensions
140+
.vscode-test
141+
142+
### Windows ###
143+
# Windows thumbnail cache files
144+
Thumbs.db
145+
Thumbs.db:encryptable
146+
ehthumbs.db
147+
ehthumbs_vista.db
148+
149+
# Dump file
150+
*.stackdump
151+
152+
# Folder config file
153+
[Dd]esktop.ini
154+
155+
# Recycle Bin used on file shares
156+
$RECYCLE.BIN/
157+
158+
# Windows Installer files
159+
*.cab
160+
*.msi
161+
*.msix
162+
*.msm
163+
*.msp
164+
165+
# Windows shortcuts
166+
*.lnk
167+
168+
# End of https://www.toptal.com/developers/gitignore/api/node,macos,windows

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,16 @@
22

33
## packages
44

5-
### `@path-tree/collection`
5+
### [`@path-tree/collection`](packages/collection)
66

77
Provides a hierarchy of directories and files from a one-dimensional array of objects, including.
88

9-
### `@path-tree/react`
9+
### [`@path-tree/react`](packages/react)
1010

1111
Provides components with a hierarchical structure.
1212

13+
[DEMO](https://codesandbox.io/s/react-path-tree-demo-khbxc)
14+
1315
## LICENSE
1416

1517
`@path-tree` is [MIT licensed](./LICENSE).

packages/react/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
## Usage
44

5+
[DEMO](https://codesandbox.io/s/react-path-tree-demo-khbxc)
6+
57
### Basic Usage
68

79
```tsx

0 commit comments

Comments
 (0)