diff --git a/README.md b/README.md new file mode 100644 index 0000000..59701f3 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# Wipe +Wipe your terminal with a smooth animation. + +This is the perfect program for you, if you like `clear` but want to add an unnecessary animation. + +## Configuration +All configuration is done using command line parameters. +If you want a persistent solution, you can add an alias to your `.bashrc` equivalent. + +TODO + +## Showcase +[![Circle](doc/circle.gif)]() +[![Rhombus](doc/rhombus.gif)]() +[![Rotation](doc/rotation.gif)]() \ No newline at end of file diff --git a/doc/circle.gif b/doc/circle.gif new file mode 100644 index 0000000..cd9f649 Binary files /dev/null and b/doc/circle.gif differ diff --git a/doc/rhombus.gif b/doc/rhombus.gif new file mode 100644 index 0000000..acba5f5 Binary files /dev/null and b/doc/rhombus.gif differ diff --git a/doc/rotation.gif b/doc/rotation.gif new file mode 100644 index 0000000..5359849 Binary files /dev/null and b/doc/rotation.gif differ