From 1de421c2915a950d49ef053837a4e0caf0399fe8 Mon Sep 17 00:00:00 2001
From: Pavlos Smith <57727226+iByteABit256@users.noreply.github.com>
Date: Mon, 13 Feb 2023 23:54:07 +0200
Subject: [PATCH] Create README.md
---
README.md | 71 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 71 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d6b5b29
--- /dev/null
+++ b/README.md
@@ -0,0 +1,71 @@
+# MRN-Generator
+
+
+
+ Table of Contents
+
+ -
+ About The Project
+
+ -
+ Getting Started
+
+
+ - Usage
+ - License
+ - Contact
+
+
+
+
+## About The Project
+
+This is a command line utility to generate MRNs conforming to [ISO 6346](https://en.wikipedia.org/wiki/ISO_6346)
+
+
+## Getting Started
+
+### Prerequisites
+
+To build the project locally you will need to [Install Rust](https://www.rust-lang.org/tools/install)
+
+### Installation
+
+```cargo build``` for a development build
+
+```cargo build --release``` for a release build
+
+(back to top)
+
+
+## Usage
+
+mrn-generator [OPTIONS] --country-code
+
+Options:
+- -c, --country-code Country code of MRN
+- -n, --number-of-mrns Number of MRNs to generate [default: 1]
+- -h, --help Print help
+- -V, --version Print version
+
+### Examples
+```mrn-generator -c DK``` to generate an MRN with Denmark as a country code
+
+```mrn-generator -c NL -n 20``` to generate 20 MRNs with Netherlands as a country code
+
+(back to top)
+
+
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+(back to top)
+
+
+## Contact
+
+Pavlos Smith - paulsmith4561@gmail.com.com