summaryrefslogtreecommitdiffstats
path: root/lib/backbone/readme.js
diff options
context:
space:
mode:
Diffstat (limited to 'lib/backbone/readme.js')
-rw-r--r--lib/backbone/readme.js20
1 files changed, 19 insertions, 1 deletions
diff --git a/lib/backbone/readme.js b/lib/backbone/readme.js
index a4cd9d8..088a942 100644
--- a/lib/backbone/readme.js
+++ b/lib/backbone/readme.js
@@ -11,7 +11,25 @@ util.inherits(Readme, BackboneFile);
Readme.prototype.type = 'readme';
-// Parse the readme content
+/*
+ Return and extension of context to define the readme
+
+ @retrun {Object}
+*/
+Readme.prototype.getContext = function() {
+ return {
+ readme: {
+ path: this.path
+ }
+ };
+};
+
+/*
+ Parse the readme content
+
+ @param {String} content
+ @retrun {Promise}
+*/
Readme.prototype.parse = function(content) {
var that = this;