Added README file

This explains what each script is used for.

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8a4021
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+## Description
+
+Provides a collection of handy ~/bin scripts
+
+*   **i3-lock-wrapper**: Wrapper around the i3 window manager lock program,
+    i3lock. Takes a screenshot of the current screen, blurs and desaturates,
+    then sets as the lock screen background.
+
+*   **screenshot.sh**: Takes a screenshot from the command line. Useful for i3
+    users who set up hotkeys that call scripts.
+
+*   **share_desktop.sh**: Sets up a readonly passworded vnc session for desktop
+    sharing. Serves as a fairly nice replacement for proprietary desktop
+    sharing applications.
+
+*   **vid_compress**: Compresses the given video to ogv (for now). The original
+    is not deleted. Useful for when lots of video was taken on a trip and you
+    don't want to keep the highest quality uncompressed originals around.
+
+*   **virtualize**: Uses qemu and libvirt to quickly virtualize a single system
+    in the foreground. Useful for spinning up quick virtual machines with short
+    lives (eg: for testing purposes)