From dd979be19bfde526d87c0c16c72dd38e43708ce0 Mon Sep 17 00:00:00 2001
From: foxcaulfield <fox.caulfield@gmail.com>
Date: Sat, 23 Dec 2023 09:06:07 +0300
Subject: [PATCH] Update README.md

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

diff --git a/README.md b/README.md
index f3a248b..51b9d4b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,42 @@
 # lorem-gen
 Lorem Ipsum console generator
+
+## Program Description
+
+This program generates random paragraphs of Lorem Ipsum text based on the specified number of paragraphs and sentences. It's a fun way to generate placeholder text for your projects or experiments.
+
+## How to Use
+
+To use the lorem-gen program, follow these steps:
+
+1. Clone the repository to your local machine.
+2. Compile the program using CMake.
+3. Run the program with two command-line arguments: the number of paragraphs and the number of sentences per paragraph.
+
+Here's an example command to run the program:
+
+```
+./lorem-gen 2 3
+```
+
+This command will generate 2 paragraphs, each containing 3 sentences.
+
+## Example Output
+
+Running the program with the command `./lorem-gen 2 3` will produce the following output:
+
+```
+Lorem ipsum dolor sit amet. Consectetur adipiscing elit. Mauris condimentum.
+
+Lacus in placerat commodo. Libero felis pulvinar orci. Eget interdum orci quam vel enim.
+
+Curabitur id orci eu tortor ullamcorper lacinia. Curabitur turpis orci. Consectetur vitae iaculis a.
+```
+
+## Dependencies
+
+The program requires CMake version 3.20.0 or higher and a C++20 compatible compiler.
+
+## License
+
+This program is licensed under the MIT License. See the LICENSE file for more information.