Skip to content

Commit fe67c20

Browse files
committed
Add more docs
1 parent a806b12 commit fe67c20

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

readme.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,12 @@
1010

1111
[**hast**][hast] utility to create [*trees*][tree] in HTML or SVG.
1212

13-
Similar to [hyperscript][] (and [`virtual-hyperscript`][virtual-hyperscript])
13+
Similar to [`hyperscript`][hyperscript], [`virtual-dom/h`][virtual-hyperscript],
14+
[`React.createElement`][react], and [Vue’s `createElement`][vue],
1415
but for [**hast**][hast].
1516

17+
Use [`unist-builder`][u] to create any [**unist**][unist] tree.
18+
1619
## Install
1720

1821
[npm][]:
@@ -21,7 +24,7 @@ but for [**hast**][hast].
2124
npm install hastscript
2225
```
2326

24-
## Usage
27+
## Use
2528

2629
```js
2730
var h = require('hastscript')
@@ -149,6 +152,7 @@ Simple CSS selector (`string`, optional).
149152
Can contain a tag name (`foo`), IDs (`#bar`), and classes (`.baz`).
150153
If there is no tag name in the selector, `h` defaults to a `div` element,
151154
and `s` to a `g` element.
155+
`selector` is parsed by [`hast-util-parse-selector`][parse-selector].
152156

153157
###### `properties`
154158

@@ -217,9 +221,15 @@ abide by its terms.
217221

218222
[coc]: https://github.com/syntax-tree/.github/blob/master/code-of-conduct.md
219223

224+
[hyperscript]: https://github.com/dominictarr/hyperscript
225+
220226
[virtual-hyperscript]: https://github.com/Matt-Esch/virtual-dom/tree/master/virtual-hyperscript
221227

222-
[hyperscript]: https://github.com/dominictarr/hyperscript
228+
[react]: https://reactjs.org/docs/glossary.html#react-elements
229+
230+
[vue]: https://vuejs.org/v2/guide/render-function.html#createElement-Arguments
231+
232+
[unist]: https://github.com/syntax-tree/unist
223233

224234
[tree]: https://github.com/syntax-tree/unist#tree
225235

@@ -228,3 +238,7 @@ abide by its terms.
228238
[element]: https://github.com/syntax-tree/hast#element
229239

230240
[text]: https://github.com/syntax-tree/hast#text
241+
242+
[u]: https://github.com/syntax-tree/unist-builder
243+
244+
[parse-selector]: https://github.com/syntax-tree/hast-util-parse-selector

0 commit comments

Comments
 (0)