Merge branch 'feature/update-code' into develop

[rbdr/blog] / README.md

diff --git a/README.md b/README.md
index 2634854dd4ec037996a2c2b1ccf78d2b40e52431..418f37e143a56bc50875ea7e3ddf090b50928b1e 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,54 @@
 # blog
-A temporary blog
+
+Blog at unlimited.pizza -> Only 3 at a time.
+
+## How to install
+
+`npm install -g .` will expose the `blog` binary to your CLI.
+
+## How to add a new entry
+
+Create a directory with a `.md` markdown file, and an `/assets`
+directory with anything you want in there. This can be in any directory.
+
+```
+.
+└── this-is-an-example-post
+    ├── assets
+    │   └── example.png
+    └── this-is-an-example-post.md
+```
+
+You can add this to the blog using the following command, it will shift
+all entries and remove the oldest one if limit of posts is reached
+(defualts to 3):
+
+`blog --add path/to/blog_post`
+
+These commands will regenerate the static files. At that point you can
+preview your blog by serving the files on the `static` directory.
+
+If you need to make corrections use:
+
+`blog --update path/to/blog_post`
+
+This will replace the latest with the contents of the `path` without
+shifting the existing entries.
+
+`blog --publish`
+
+Will publish the blog. (Currently unsupported)
+
+## How to publish
+
+At the moment, the app does not include any publishers. [surge][surge] is an easy
+way to do it, just point it to your static directory.
+
+## Debugging
+
+If you want to know more about what's going on when blog generates
+data, set the environment variable `NODE_DEBUG=blog`. This will
+enable the debug messages
+
+
+[surge]: https://surge.sh