From 9b2fc9616b2909ea52e82a1e27bb06d08fc9d1c4 Mon Sep 17 00:00:00 2001
From: Unbewohnte <me@unbewohnte.xyz>
Date: Sun, 6 Feb 2022 16:28:16 +0300
Subject: [PATCH] Added README

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..882488d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# mandelplot
+### Generate mandelbrot set with specified dimensions, a couple of palettes included !
+
+## Usage
+mandelplot [OPTIONS]
+
+OPTIONS:
+
+- `-d, --image_dimensions <image_dimensions>` => Set image dimensions (WIDTHxHEIGHT) [default: 7680x4320]
+
+- `-h, --help` => Print help information
+
+- `-i, --max_iter <max_iter>` => Specify maximum amount of iterations to decide whether the point escapes to infinity or  not [default: 1000]
+
+- `-n, --image_name <image_name>` => Set output image filename [default: mandelbrot]
+
+- `-p, --palette <palette>` => Specify bulb color (light, dark) [default: light]
+
+- `-V, --version` => Print version information
+
+
+## TODO:
+- generate image in parallel
\ No newline at end of file