aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Beltran <ben@nsovocal.com>2017-07-02 21:31:10 -0500
committerBen Beltran <ben@nsovocal.com>2017-07-02 21:31:10 -0500
commit7a5a585ead8c4e967980adc2ab9c7502e47694fd (patch)
tree8f2fd840fc5620e5f4b44c607dd474db5e08d371 /README.md
parent4ae55e0673a61c50f1f7f378f6461d0388f66bd5 (diff)
💄📝 Add basic static layout + readme/contributing
Squashed commit of the following: commit f32ca088e9b4d9c6b6edad5271757d886f7177e8 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:30:20 2017 -0500 Add CHANGELOG commit f5691219950c7546343d42791034cdbba748609b Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:30:00 2017 -0500 Add mac files, and generated files to ignore commit 88ba8c1bed6a6336e1c0ebb5e5d42210a20422a7 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:28:34 2017 -0500 Add contributing guide commit 160eae6998e2559b6b9e3b21473c930b10278739 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:24:21 2017 -0500 Add readme commit 36760ff85dbd335afe2c5d9ea9596f81a0ca88a3 Author: Ben Beltran <ben@nsovocal.com> Date: Sun Jul 2 21:11:47 2017 -0500 💄 Add static layout
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 39 insertions, 1 deletions
diff --git a/README.md b/README.md
index 2634854..7f7903a 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,40 @@
# blog
-A temporary blog
+
+Blog at unlimited.pizza -> Only
+
+## 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.