From 448928da68b6ce7acf44a46ed0fbdd0dd46ee851 Mon Sep 17 00:00:00 2001
From: Fabrice Gangler <fabrice.gangler@adullact.org>
Date: Tue, 28 Feb 2023 05:48:54 +0100
Subject: [PATCH] docs: improve README

---
 README.md | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

diff --git a/README.md b/README.md
index ac338bd..d28e7da 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@ cd  vagrant-cfssl
 
 ### Step 3 - Boot a virtual machine, download and configure all required items to get a running CFSSL
 
-Some configuration values are presents in [`puppet/hieradata/parameters.yaml`](puppet/hieradata/parameters.yaml) file.
+Some *CFSSL** configuration values are presents in [`puppet/hieradata/parameters.yaml`](puppet/hieradata/parameters.yaml) file.
 You can modify this file to change value of any parameter documented by **Puppet** component module `cfssl` in
 [REFERENCE.md](https://gitlab.adullact.net/adullact/puppet-cfssl/-/blob/main/REFERENCE.md)
 
@@ -50,16 +50,8 @@ You can modify this file to change value of any parameter documented by **Puppet
 
 # Creates and starts the VM (Virtual Machine) according to the Vagrantfile
 vagrant destroy -f  # stops the running machine Vagrant and destroys all resources
-vagrant up
-
-      # Creates and starts the VM (Virtual Machine)
-      # with some customizations (ports, ip, ...)
-      # - customize CFSSL port   ---> 8888      (default, port allowed above 1000)
-      # - customize CFSSL port   ---> 127.0.0.1 (default)
-      vagrant destroy -f  # stops the running machine Vagrant and destroys all resources
-      VAGRANT_HOST_CFSSL_PORT=8888  \
-      VAGRANT_HOST_CFSSL_IP=0.0.0.0 \
-      vagrant up
+vagrant up          # Then you wait few minutes
+                    # depends on your network access and power of your computer
 
 # Stops gracefully the VM
 vagrant halt
@@ -72,7 +64,18 @@ vagrant up
 vagrant destroy -f
 ```
 
-Then you wait few minutes (depends on your network access and power of your computer).
+### Starts the VM with a custom CFSLL port and a custom CFSSL IP address
+
+```bash
+# Creates and starts the VM (Virtual Machine)
+# with some customizations (ports, ip, ...)
+# - customize CFSSL port       ---> 8888      (default, port allowed above 1000)
+# - customize CFSSL IP address ---> 127.0.0.1 (default)
+VAGRANT_HOST_CFSSL_PORT=8888  \
+VAGRANT_HOST_CFSSL_IP=0.0.0.0 \
+vagrant up
+```
+
 
 ---------------------------------
 
-- 
GitLab