From 1060fd1463b8fe6cd5aa112a4d824b6a6b62e0d3 Mon Sep 17 00:00:00 2001
From: Titus Wormer <tituswormer@gmail.com>
Date: Sat, 19 Jun 2021 11:12:25 +0200
Subject: [PATCH] Add better docs

---
 readme.md | 38 ++++++++++++++++++--------------------
 1 file changed, 18 insertions(+), 20 deletions(-)

diff --git a/readme.md b/readme.md
index ab1c1c8..797660c 100644
--- a/readme.md
+++ b/readme.md
@@ -16,10 +16,10 @@ When parsing (`from-markdown`), must be combined with
 This utility handles parsing and serializing.
 See [`micromark-extension-mdxjs-esm`][extension] for how the syntax works.
 
-You probably should use [`micromark-extension-mdxjs`][mdxjs] with
-[`mdast-util-mdx`][mdast-util-mdx] (which includes this package) to support all
-of MDX.js.
-Or use it all through [`remark-mdx`][remark-mdx] (**[remark][]**).
+## When to use this
+
+Use [`mdast-util-mdx`][mdast-util-mdx] if you want all of MDX / MDX.js.
+Use this otherwise.
 
 ## Install
 
@@ -43,26 +43,26 @@ export var c = ''
 d
 ```
 
-And our script, `example.js`, looks as follows:
+And our module, `example.js`, looks as follows:
 
 ```js
-var fs = require('fs')
-var acorn = require('acorn')
-var syntax = require('micromark-extension-mdxjs-esm')
-var fromMarkdown = require('mdast-util-from-markdown')
-var toMarkdown = require('mdast-util-to-markdown')
-var mdxjsEsm = require('mdast-util-mdxjs-esm')
-
-var doc = fs.readFileSync('example.mdx')
-
-var tree = fromMarkdown(doc, {
-  extensions: [syntax({acorn: acorn, addResult: true})],
-  mdastExtensions: [mdxjsEsm.fromMarkdown]
+import fs from 'fs'
+import * as acorn from 'acorn'
+import {fromMarkdown} from 'mdast-util-from-markdown'
+import {toMarkdown} from 'mdast-util-to-markdown'
+import mdxjsEsm from 'micromark-extension-mdxjs-esm'
+import {mdxjsEsmFromMarkdown, mdxjsEsmToMarkdown} from 'mdast-util-mdxjs-esm'
+
+const doc = fs.readFileSync('example.mdx')
+
+const tree = fromMarkdown(doc, {
+  extensions: [mdxjsEsm({acorn, addResult: true})],
+  mdastExtensions: [mdxjsEsmFromMarkdown]
 })
 
 console.log(tree)
 
-var out = toMarkdown(tree, {extensions: [mdxjsEsm.toMarkdown]})
+const out = toMarkdown(tree, {extensions: [mdxjsEsmToMarkdown]})
 
 console.log(out)
 ```
@@ -269,8 +269,6 @@ abide by its terms.
 
 [extension]: https://github.com/micromark/micromark-extension-mdxjs-esm
 
-[mdxjs]: https://github.com/micromark/micromark-extension-mdxjs
-
 [mdast-util-mdx]: https://github.com/syntax-tree/mdast-util-mdx
 
 [estree]: https://github.com/estree/estree