gitbook/lib/backbone/readme.js

var util = require('util');
var BackboneFile = require('./file');

function Readme() {
    BackboneFile.apply(this, arguments);

    this.title;
    this.description;
}
util.inherits(Readme, BackboneFile);

Readme.prototype.type = 'readme';

/*
    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;

    return this.parser.readme(content)
    .then(function(out) {
        that.title = out.title;
        that.description = out.description;
    });
};


module.exports = Readme;