starting v2
[pb.git] / README.md
index 3afba86..f62b3f1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,5 +1,7 @@
 All you really need is just the pb file, the others are there for demonstration purposes, you can just download that file by itself if you don't want the extra garbage.
 
+This project was inspired by Luke's [lb](https://github.com/LukeSmithxyz/lb). I found it a bit annoying to have to edit the html snippet that gets inserted for new blog posts, so this project abstracts the snippet out as a template file that the user can edit. Of course, that means that this is much more bloated.
+
 # 'Installation'
 Before running the script, open it up and change the variables at the top of the file to your liking.
 
@@ -7,12 +9,12 @@ You need a couple of things to get the script:
 - A blog index file (a page with a list of all of your posts)
 - A rolling blog file (a feed of posts will be placed here)
 - A rss file
+- A template for each blog entry
 
 In each of these files, you need to include the comments:
 ```
 <!-- BLOG START -->
 <!-- BLOG END -->
-
 ```
 
 # Usage
@@ -25,9 +27,6 @@ Publishes a draft, which means that it takes the html snippet you wrote and shov
 ### d / delete
 Deletes an already published blog post, this does not delete your draft.
 
-### b / backup
-Simply copies all draft and published blog entries into the backup directory.
-
 ### r / refresh (planned)
 Used when you change the template file and want to keep all blog entries consistent. It deletes all html files and republishes them all.
 
@@ -38,4 +37,4 @@ You can use certain keywords that will be substituted in:
 - {{TITLE}} for the title of the blog post
 - {{DATE}}
 - {{URL}} pointing to that post
-- {{BODY}} the html of that post
+- {{BODY}} the html body of the blog post