aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e795212
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# Bubbles
+
+Creates a procedurally generated image that sort of looks like bubbles
+
+USAGE:
+ bubbles --width <WIDTH> --height <HEIGHT> --frames <FRAMES> --num-cells <NUM_CELLS> --out <OUT>
+
+OPTIONS:
+ -f, --frames <FRAMES> number of gif frames
+ -h, --height <HEIGHT> height of the image
+ --help Print help information
+ -n, --num-cells <NUM_CELLS> number of cells to generate
+ -o, --out <OUT> output file
+ -V, --version Print version information
+ -w, --width <WIDTH> width of the image