From 203d151f4de1d7f14225e1ed4286e71f1bf8b1dc Mon Sep 17 00:00:00 2001
From: Antony Nevis <asocial@nevisfamily.com>
Date: Mon, 8 Apr 2024 08:45:40 +1000
Subject: [PATCH] Add extra info to README.txt

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

diff --git a/README.md b/README.md
index 172a27d..06ed141 100644
--- a/README.md
+++ b/README.md
@@ -2,8 +2,26 @@
 
 A Python utility to take a JSON / YAML file or a python dict / list and create a Markdown file.
 
+## Installation
+
+```bash
+pip install yaml-to-markdown
+```
+
 ## Usage
 
+```bash
+$ yaml-to-markdown --help
+Convert JSON or YAML to Markdown.
+Usage: yaml-to-markdown -o <output_file> [-y <yaml_file> | -j <json_file>]
+    -o, --output-file <output_file>: Path to the output file as a string [Mandatory].
+    -y, --yaml-file <yaml_file>: Path to the YAML file as a string [Optional]
+    -j, --json-file <json_file>: Path to the JSON file as a string [Optional]
+    -h, --help: Show this message and exit.
+Note: Either yaml_file or json_file is required along with output_file.
+Example: yaml-to-markdown -o output.md -y data.yaml
+```
+
 ### In Python Code example:
 
 #### Convert a Pyton dictionary to Markdown: