Skip to content

Commit e182b20

Browse files
committed
Updates docs.
1 parent 1a8ae56 commit e182b20

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,9 @@ That being said you do have a bail-out ability allowing you to suspend the trave
114114

115115
The API is very simple at the moment, only exposing a single function, which you can import as follows
116116

117-
### `react-tree-walker` (`Function`)
117+
### **reactTreeWalker**
118+
119+
The default export of the library. The function that performs the magic.
118120

119121
```
120122
const reactTreeWalker = require('react-tree-walker')
@@ -156,9 +158,11 @@ import reactTreeWalker from 'react-tree-walker'
156158

157159
A `Promise` that resolves when the tree walking is completed.
158160

159-
### `visitor`
161+
### **visitor**
162+
163+
The function that you create and provide to `reactTreeWalker`.
160164

161-
Encapsulates the logic you wish to execute against each element. You create and provide this function to the `reactTreeWalker`.
165+
It should encapsulates the logic you wish to execute against each element.
162166

163167
**Parameters**
164168

0 commit comments

Comments
 (0)