diff options
Diffstat (limited to 'lib/models/readme.js')
-rw-r--r-- | lib/models/readme.js | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/lib/models/readme.js b/lib/models/readme.js new file mode 100644 index 0000000..c655c82 --- /dev/null +++ b/lib/models/readme.js @@ -0,0 +1,40 @@ +var Immutable = require('immutable'); + +var File = require('./file'); + +var Readme = Immutable.Record({ + file: File(), + title: String(), + description: String() +}); + +Readme.prototype.getFile = function() { + return this.get('file'); +}; + +Readme.prototype.getTitle = function() { + return this.get('title'); +}; + +Readme.prototype.getDescription = function() { + return this.get('description'); +}; + +/** + Create a new readme + + @param {File} file + @param {Object} def + @return {Readme} +*/ +Readme.create = function(file, def) { + def = def || {}; + + return new Readme({ + file: file, + title: def.title || '', + description: def.description || '' + }); +}; + +module.exports = Readme; |