Add logic skeleton for rust version

[rbdr/blog] / doc / README.md

diff --git a/doc/README.md b/doc/README.md
index 4e9e13197d88e6d637f3b7691455c18512528fa1..988e0e7ae6c79e0160fe7d799087c095da020fa3 100644 (file)
--- a/doc/README.md
+++ b/doc/README.md
@@ -1,3 +1,27 @@
+## Classes
+
+<dl>
+<dt><a href="#Blog">Blog</a></dt>
+<dd></dd>
+</dl>
+
+## Members
+
+<dl>
+<dt><a href="#HTMLGenerator">HTMLGenerator</a></dt>
+<dd><p>Generates the blog index page</p>
+</dd>
+<dt><a href="#RSSGenerator">RSSGenerator</a></dt>
+<dd><p>Generates an RSS feed XML file</p>
+</dd>
+<dt><a href="#StaticGenerator">StaticGenerator</a></dt>
+<dd><p>Generates the static assets required for the blog</p>
+</dd>
+<dt><a href="#TXTGenerator">TXTGenerator</a></dt>
+<dd><p>Generates a TXT version of the blog</p>
+</dd>
+</dl>
+

 <a name="Blog"></a>
 
 ## Blog
 <a name="Blog"></a>
 
 ## Blog


@@ -8,6 +32,11 @@
     * [.add(postLocation)](#Blog+add) ⇒ <code>Promise.&lt;undefined&gt;</code>
     * [.update(postLocation)](#Blog+update) ⇒ <code>Promise.&lt;undefined&gt;</code>
     * [.publish()](#Blog+publish) ⇒ <code>Promise.&lt;undefined&gt;</code>
     * [.add(postLocation)](#Blog+add) ⇒ <code>Promise.&lt;undefined&gt;</code>
     * [.update(postLocation)](#Blog+update) ⇒ <code>Promise.&lt;undefined&gt;</code>
     * [.publish()](#Blog+publish) ⇒ <code>Promise.&lt;undefined&gt;</code>

+    * [.publishArchive()](#Blog+publishArchive) ⇒ <code>Promise.&lt;undefined&gt;</code>
+    * [.addRemote()](#Blog+addRemote) ⇒ <code>Promise.&lt;undefined&gt;</code>
+    * [.removeRemote()](#Blog+removeRemote) ⇒ <code>Promise.&lt;undefined&gt;</code>
+    * [.syncDown()](#Blog+syncDown) ⇒ <code>Promise.&lt;undefined&gt;</code>
+    * [.syncUp()](#Blog+syncUp) ⇒ <code>Promise.&lt;undefined&gt;</code>

 
 <a name="new_Blog_new"></a>
 
 
 <a name="new_Blog_new"></a>
 


@@ -18,12 +47,12 @@ updating posts, and handling the publishing.
 
 | Param | Type | Description |
 | --- | --- | --- |
 
 | Param | Type | Description |
 | --- | --- | --- |

-| config | <code>Potluck.tConfiguration</code> | the initialization options to extend the instance |
+| config | <code>Blog.tConfiguration</code> | the initialization options to extend the instance |

 
 <a name="Blog+add"></a>
 
 ### blog.add(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
 
 <a name="Blog+add"></a>
 
 ### blog.add(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>

-Shifts the blog posts, adds the passed path to slot 0, and
+Shifts the blog posts, adds the passed file to slot 0, and

 generates files.
 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  
 generates files.
 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  


@@ -31,19 +60,19 @@ generates files.
 
 | Param | Type | Description |
 | --- | --- | --- |
 
 | Param | Type | Description |
 | --- | --- | --- |

-| postLocation | <code>string</code> | the path to the directory containing the post structure |
+| postLocation | <code>string</code> | the path to the blog post file |

 
 <a name="Blog+update"></a>
 
 ### blog.update(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
 
 <a name="Blog+update"></a>
 
 ### blog.update(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>

-Adds the passed path to slot 0, and generates files.
+Update slot 0 with the passed gmi file, and generates files.

 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  
 **Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
 
 | Param | Type | Description |
 | --- | --- | --- |
 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  
 **Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
 
 | Param | Type | Description |
 | --- | --- | --- |

-| postLocation | <code>string</code> | the path to the directory containing the post structure |
+| postLocation | <code>string</code> | the path to the blog post file |

 
 <a name="Blog+publish"></a>
 
 
 <a name="Blog+publish"></a>
 


@@ -52,3 +81,91 @@ Publishes the files to a static host.
 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  
 **Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
 
 **Kind**: instance method of [<code>Blog</code>](#Blog)  
 **Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  

+<a name="Blog+publishArchive"></a>
+
+### blog.publishArchive() ⇒ <code>Promise.&lt;undefined&gt;</code>
+Publishes the archive to a host using rsync. Currently assumes
+gemlog archive.
+
+**Kind**: instance method of [<code>Blog</code>](#Blog)  
+**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
+<a name="Blog+addRemote"></a>
+
+### blog.addRemote() ⇒ <code>Promise.&lt;undefined&gt;</code>
+Adds a remote
+
+**Kind**: instance method of [<code>Blog</code>](#Blog)  
+**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
+<a name="Blog+removeRemote"></a>
+
+### blog.removeRemote() ⇒ <code>Promise.&lt;undefined&gt;</code>
+Removes a remote
+
+**Kind**: instance method of [<code>Blog</code>](#Blog)  
+**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
+<a name="Blog+syncDown"></a>
+
+### blog.syncDown() ⇒ <code>Promise.&lt;undefined&gt;</code>
+Pulls the posts and archive from the remote
+
+**Kind**: instance method of [<code>Blog</code>](#Blog)  
+**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
+<a name="Blog+syncUp"></a>
+
+### blog.syncUp() ⇒ <code>Promise.&lt;undefined&gt;</code>
+Pushes the posts and archive to the remote
+
+**Kind**: instance method of [<code>Blog</code>](#Blog)  
+**Returns**: <code>Promise.&lt;undefined&gt;</code> - empty promise, returns no value  
+<a name="HTMLGenerator"></a>
+
+## HTMLGenerator
+Generates the blog index page
+
+**Kind**: global variable  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| source | <code>string</code> | the source directory |
+| target | <code>string</code> | the target directory |
+| posts | <code>Array.&lt;Blog.tPost&gt;</code> | the list of posts |
+
+<a name="RSSGenerator"></a>
+
+## RSSGenerator
+Generates an RSS feed XML file
+
+**Kind**: global variable  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| source | <code>string</code> | the source directory |
+| target | <code>string</code> | the target directory |
+| posts | <code>Array.&lt;Blog.tPost&gt;</code> | the list of posts |
+
+<a name="StaticGenerator"></a>
+
+## StaticGenerator
+Generates the static assets required for the blog
+
+**Kind**: global variable  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| source | <code>string</code> | the source directory |
+| target | <code>string</code> | the target directory |
+| posts | <code>Array.&lt;Blog.tPost&gt;</code> | the list of posts |
+
+<a name="TXTGenerator"></a>
+
+## TXTGenerator
+Generates a TXT version of the blog
+
+**Kind**: global variable  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| source | <code>string</code> | the source directory |
+| target | <code>string</code> | the target directory |
+| posts | <code>Array.&lt;Blog.tPost&gt;</code> | the list of posts |
+