Update readme.md

[teinett]

Added installation of package unist-builder.
The example in readme.md file doesn't work without it.

[github-actions]

Hi! It seems you removed the template which we require. Here are our templates (pick the one you want to use and click *raw* to see its source):

• pull-request-template.md

I won’t send you any further notifications about this, but I’ll keep on updating this comment, and hide it when done!

Thanks,
— bb

[ChristianMurphy]

unist-builder is not required to use the module.
It is shown in the example, but unist-util-visit works fine independently.

A potential ideas to help clarify this:

• add a "unist-builder is used here" type note to the use section
• or update the example to use plain JSON, rather than a builder
• or something else

Thoughts? 💭

[teinett]

I tried to use the code of example without npm install unist-builder. The example gives the error:

[wooorm]

Could you answer @ChristianMurphy’s comment?

[ChristianMurphy]

I tried to use the code of example without npm install unist-builder. The example gives the error ...

Right, "install" shows how to install this module, "use" provides an example of this module used along side another module.

For example, consider if the example was replaced with

import {visit} from 'unist-util-visit'
import remark from 'remark'

const tree = remark().parse('Some _emphasis_, **importance**, and `code`.')

visit(tree, (node) => console.log(node))

this shows usage with remark, without unist-builder.
unist-util-visit is the key part here, not remark or unist-builder, encouraging installing a dependency which is not needed could cause confusion and/or add an unnecessary dependency.

[teinett]

For beginners, it would be helpful to have a readme part "Don't forget" with text, how to use the example from zero

Don't forget to install all dependencies for this example: `npm install unist-builder unist-util-visit`

[ChristianMurphy]

For beginners, it would be helpful to have a readme part "Don't forget" with text, how to use the example from zero

I agree, that's one of the suggestions from #26 (review)
Would you be interested in updating the readme to include that, or one of the other suggestions?

[teinett]

Would you be interested in updating the readme to include that, or one of the other suggestions?
I didn't know how to change this pull request, so I created the new one: #27.

If it's OK for you, I can update readme files of other projects with the same pattern.

[teinett]

Changed in #27

[github-actions]

Hi! This was closed. Team: If this was merged, please describe when this is likely to be released. Otherwise, please add one of the no/* labels.