From f171449530f8984374c8f69fff3c92af813a694b Mon Sep 17 00:00:00 2001
From: Adam Matthews <52178922+adamsthws@users.noreply.github.com>
Date: Wed, 12 Jun 2024 20:38:24 +0100
Subject: [PATCH] Update README.md (#226)

* Update README.md

Enhance visibility of log2ram filesystem type

Changed the command...
  `df -h | grep log2ram`
to:
  `df -hT | grep log2ram`

This provides additional clarity by explicitly showing the type of filesystem (e.g. tmpfs) where 'log2ram' is mounted. This makes the output more useful for diagnostics and ensuring correct configuration.

* Update README.md

Update the example for 'df -hT...'

* Update README.md

Update README with Clearer Examples

Improves readability and provides more immediate comprehension for users checking filesystem mount details. (Uses `awk` to provide more descriptive output).

1. Modified the `df -hT | grep log2ram` command to include labels for each output field, making it easier to understand the filesystem statistics.

2. Updated the `mount | grep log2ram` command to better display information about the `log2ram` mount.
---
 README.md | 26 +++++++++++++++++++++-----
 1 file changed, 21 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 13d1cc3..dd2a2ab 100644
--- a/README.md
+++ b/README.md
@@ -59,14 +59,30 @@ The log is also written to `/var/log/log2ram.log`.
 You can also inspect the mount folder in RAM with:
 
 ```bash
-# df -h | grep log2ram
-log2ram          40M  532K   40M   2% /var/log
+df -hT | grep log2ram | awk '{print " Name: " $1 "\nMount: " $7 "\n Type: " $2 "\nUsage: " $6 "\n Size: " $3 "\n Used: " $4 "\n Free: " $5}'
 ```
-or also:
+Returns:
+```bash
+ Name: log2ram
+Mount: /var/log
+ Type: tmpfs
+Usage: 72%
+ Size: 128M
+ Used: 93M
+ Free: 36M
+```
+
+Or also:
 
 ```bash
-# mount | grep log2ram
-log2ram on /var/log type tmpfs (rw,nosuid,nodev,noexec,relatime,size=40960k,mode=755)
+mount | grep log2ram | awk -F'[ ()]+' '{print "   Name: " $1 "\n  Mount: " $3 "\n   Type: " $5 "\nOptions: " $6}'
+```
+Returns:
+```bash
+   Name: log2ram
+  Mount: /var/log
+   Type: tmpfs
+Options: rw,nosuid,nodev,noexec,noatime,size=131072k,mode=755,uid=100000,gid=100000,inode64
 ```
 
 If you do not get any line as response of these commands, something is not working. Refer to [this section](#is-it-working).