Autogenerated docs and setup for dom-ready

WordPress · Mar 6, 2019 · ba00cbb · ba00cbb
1 parent 7d98658
commit ba00cbb
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 1 deletion.
diff --git a/packages/dom-ready/README.md b/packages/dom-ready/README.md
@@ -24,6 +24,27 @@ domReady( function() {
 
 ## Browser support
 
-See https://make.wordpress.org/design/handbook/design-guide/browser-support/
+See <https://make.wordpress.org/design/handbook/design-guide/browser-support/>
+
+## API
+
+<!-- START TOKEN(Autogenerated API docs) -->
+
+### default
+
+[src/index.js#L20-L20](src/index.js#L20-L20)
+
+Specify a function to execute when the DOM is fully loaded.
+
+**Parameters**
+
+-   **callback** `Function`: A function to execute after the DOM is ready.
+
+**Returns**
+
+`void` 
+
+
+<!-- END TOKEN(Autogenerated API docs) -->
 
 <br/><br/><p align="center"><img src="https://s.w.org/style/images/codeispoetry.png?1" alt="Code is Poetry." /></p>
diff --git a/packages/dom-ready/package.json b/packages/dom-ready/package.json
@@ -22,7 +22,13 @@
 	"dependencies": {
 		"@babel/runtime": "^7.3.1"
 	},
+	"devDependencies": {
+		"@wordpress/docgen": "file:../docgen"
+	},
 	"publishConfig": {
 		"access": "public"
+	},
+	"scripts": {
+		"docs:generate": "docgen ./src/index.js --output ./README.md --to-token"
 	}
 }