Base

1 files changed, 24 insertions, 0 deletions

diff --git a/lib/parse/parseReadme.js b/lib/parse/parseReadme.js
new file mode 100644
index 0000000..ea6ef59
--- /dev/null
+++ b/lib/parse/parseReadme.js
@@ -0,0 +1,24 @@
+var parseStructureFile = require('./parseStructureFile');
+var Readme = require('../models/readme');
+
+var error = require('../utils/error');
+
+/**
+    Parse readme from book
+
+    @param {Book} book
+    @return {Promise<Book>}
+*/
+function parseReadme(book) {
+    return parseStructureFile(book, 'readme')
+    .spread(function(file, result) {
+        if (!file) {
+            throw new error.FileNotFoundError({ filename: 'README' });
+        }
+
+        var readme = Readme.create(file, result);
+        return book.set('readme', readme);
+    });
+}
+
+module.exports = parseReadme;