Base

1 files changed, 30 insertions, 0 deletions

diff --git a/lib/models/readme.js b/lib/models/readme.js
new file mode 100644
index 0000000..7a184c4
--- /dev/null
+++ b/lib/models/readme.js
@@ -0,0 +1,30 @@
+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');
+};
+
+/**
+    Create a new readme
+
+    @param {File} file
+    @param {Object} def
+    @return {Readme}
+*/
+Readme.create = function(file, def) {
+    return new Readme({
+        file: file,
+        title: def.title,
+        description: def.description
+    });
+};
+
+module.exports = Readme;