1 files changed, 6 insertions, 1 deletions
diff --git a/packages/gitbook-html/lib/readme.js b/packages/gitbook-html/lib/readme.js
index 0d179ad..34e447e 100755
--- a/packages/gitbook-html/lib/readme.js
+++ b/packages/gitbook-html/lib/readme.js
@@ -1,7 +1,12 @@
 var _ = require('lodash');
 var dom = require('./dom');
 
-// HTML -> Readme
+/**
+    Parse an HTML content into metadata about a readme
+
+    @param {String} html
+    @return {Object}
+*/
 function parseReadme(html) {
     var $ = dom.parse(html);