From 6976b4856f9bf31692a8f0fb8f3e3719deb84ba1 Mon Sep 17 00:00:00 2001
From: Simon Petit <nomisp96@hotmail.fr>
Date: Sat, 16 Nov 2024 12:02:40 +0100
Subject: [PATCH] improwing readme

---
 README.md | 31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 2e2c772..d07c6e2 100644
--- a/README.md
+++ b/README.md
@@ -11,22 +11,36 @@ like machine.
 ```
 git clone https://git.simonpetit.top
 cd bob
+make test (optional)
 sudo make install
 ```
 
 ## Usage
 
+### Publish : to convert a drafts in markdown into a html article 
+
 To write a post, create a markdown file in the `drafts` folder whose name will
 also be its title, and convert it to an html file, type the following command
 from the root :
 
 ```
-bob publish
+bob publish ./drafts/<article_file>
 ```
 
-The publishing command will rep-ublish all the drafts, that is why
-anytime you want a post removed, delete in from the drafts folder and re-publish
-your blog.
+Note that the article does not have to have a particular extension, however
+it will be placed in the `draft/published` folder with the `.md` extension.
+It will also update the `index.html` to add this newly article into its list.
+
+### Unpublish : to remove a published article
+
+```
+bob unpublish ./posts/<article_file>
+```
+
+This will remove the html file from the `posts` folder, and put back the draft from 
+`./draft/published` into the `./draft` folder.
+
+### Help
 
 See the help for additional command, such as modification of the main configuration
 of the blog.
@@ -41,14 +55,5 @@ bob help
   such as tweeter, github, dev.to ...).
 * Complete the CSS files.
 * Add a comment/like section ?
-* Adding a git component, and a server configuration to allow synchronisation.
-  Maybe the drafts folder on the personal computer triggers changes on the git
-  repo of the server which re-publishes the blog automatically.
-* Add a way to do all the construction of the blog on the personal computer but
-  to send the html files to a distant server.
 * Consider adding configuration files for some/all posts (if they
   need special javascript included e.g. MathJax, AJAX, sockets ...).
-* Add a preview function for TRUE drafts being written
-* Take into account the headers possibilities of multimarkdown, which could
-  replace the self header writing process and include other features such as
-  Mathjax