Add improved docs

wooorm · web-flow · commit 4185f06d7e78 · 2021-11-29T19:24:12.000+01:00
Closes GH-657 Reviewed-by: Merlijn Vos <merlijn@soverin.net>
diff --git a/lib/react-markdown.js b/lib/react-markdown.js
@@ -65,6 +65,8 @@ const deprecated = {
 }
 
 /**
+ * React component to render markdown.
+ *
  * @param {ReactMarkdownOptions} options
  * @returns {ReactElement}
  */
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "react-markdown",
   "version": "7.1.0",
-  "description": "Render Markdown as React components",
+  "description": "React component to render markdown",
   "license": "MIT",
   "keywords": [
     "remark",
diff --git a/readme.md b/readme.md

Original file line number	Diff line number	Diff line change
`@@ -65,6 +65,8 @@ const deprecated = {`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
	`68`	`+ * React component to render markdown.`
	`69`	`+ *`
`68`	`70`	`* @param {ReactMarkdownOptions} options`
`69`	`71`	`* @returns {ReactElement}`
`70`	`72`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "react-markdown",`
`3`	`3`	`"version": "7.1.0",`
`4`		`- "description": "Render Markdown as React components",`
	`4`	`+ "description": "React component to render markdown",`
`5`	`5`	`"license": "MIT",`
`6`	`6`	`"keywords": [`
`7`	`7`	`"remark",`