X-Git-Url: https://git.r.bdr.sh/rbdr/blog/blobdiff_plain/5aabf12286e74aeb60b829d6401db8b17881a03f..d92ac8ccf6516011bc40bff2b17ef0d0d766f9de:/doc/README.md?ds=inline
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 0000000..4e9e131
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,54 @@
+
+
+## Blog
+**Kind**: global class
+
+* [Blog](#Blog)
+ * [new Blog(config)](#new_Blog_new)
+ * [.add(postLocation)](#Blog+add) â Promise.<undefined>
+ * [.update(postLocation)](#Blog+update) â Promise.<undefined>
+ * [.publish()](#Blog+publish) â Promise.<undefined>
+
+
+
+### new Blog(config)
+The Blog class is the blog generator, it's in charge of adding and
+updating posts, and handling the publishing.
+
+
+| Param | Type | Description |
+| --- | --- | --- |
+| config | Potluck.tConfiguration
| the initialization options to extend the instance |
+
+
+
+### blog.add(postLocation) â Promise.<undefined>
+Shifts the blog posts, adds the passed path to slot 0, and
+generates files.
+
+**Kind**: instance method of [Blog
](#Blog)
+**Returns**: Promise.<undefined>
- empty promise, returns no value
+
+| Param | Type | Description |
+| --- | --- | --- |
+| postLocation | string
| the path to the directory containing the post structure |
+
+
+
+### blog.update(postLocation) â Promise.<undefined>
+Adds the passed path to slot 0, and generates files.
+
+**Kind**: instance method of [Blog
](#Blog)
+**Returns**: Promise.<undefined>
- empty promise, returns no value
+
+| Param | Type | Description |
+| --- | --- | --- |
+| postLocation | string
| the path to the directory containing the post structure |
+
+
+
+### blog.publish() â Promise.<undefined>
+Publishes the files to a static host.
+
+**Kind**: instance method of [Blog
](#Blog)
+**Returns**: Promise.<undefined>
- empty promise, returns no value