]> git.r.bdr.sh - rbdr/blog/blobdiff - doc/README.md
Remove unused JS code and docs
[rbdr/blog] / doc / README.md
diff --git a/doc/README.md b/doc/README.md
deleted file mode 100644 (file)
index 4e9e131..0000000
+++ /dev/null
@@ -1,54 +0,0 @@
-<a name="Blog"></a>
-
-## Blog
-**Kind**: global class  
-
-* [Blog](#Blog)
-    * [new Blog(config)](#new_Blog_new)
-    * [.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>
-
-<a name="new_Blog_new"></a>
-
-### 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 | <code>Potluck.tConfiguration</code> | the initialization options to extend the instance |
-
-<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
-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 |
-| --- | --- | --- |
-| postLocation | <code>string</code> | the path to the directory containing the post structure |
-
-<a name="Blog+update"></a>
-
-### blog.update(postLocation) ⇒ <code>Promise.&lt;undefined&gt;</code>
-Adds the passed path to slot 0, 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 |
-| --- | --- | --- |
-| postLocation | <code>string</code> | the path to the directory containing the post structure |
-
-<a name="Blog+publish"></a>
-
-### blog.publish() ⇒ <code>Promise.&lt;undefined&gt;</code>
-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