From 58f7581be9817bf504dcf469e3d3dca94326c29d Mon Sep 17 00:00:00 2001
From: Donovan Glover <donovan@dglover.co>
Date: Sun, 18 Nov 2018 15:20:14 -0500
Subject: [PATCH] docs: Add READMEs for bspwm, polybar, and rtv

---
 bspwm/README.md   | 18 ++++++++++++++++++
 polybar/README.md | 17 +++++++++++++++++
 rtv/README.md     | 17 +++++++++++++++++
 3 files changed, 52 insertions(+)
 create mode 100644 bspwm/README.md
 create mode 100644 polybar/README.md
 create mode 100644 rtv/README.md

diff --git a/bspwm/README.md b/bspwm/README.md
new file mode 100644
index 00000000..4a486093
--- /dev/null
+++ b/bspwm/README.md
@@ -0,0 +1,18 @@
+# bspwm
+
+[bspwm][bspwm] is a tiling window manager for X11.
+
+## Use Cases
+
+bspwm can be used to:
+
+- Automatically tile all kinds of windows, maximizing screen estate
+- Have complete control of your window manager through simple shell commands
+- Minimize resource usage; bspwm works best without a desktop environment
+
+You should not use bspwm if:
+
+- You are using a desktop environment
+- You just want to open multiple shells (use [kitty](/kitty) or [tmux](/tmux) for this instead)
+
+[bspwm]: https://github.com/baskerville/bspwm
diff --git a/polybar/README.md b/polybar/README.md
new file mode 100644
index 00000000..0e1a13d5
--- /dev/null
+++ b/polybar/README.md
@@ -0,0 +1,17 @@
+# polybar
+
+[polybar][polybar] is an information panel for your desktop.
+
+## Use Cases
+
+polybar can be used to:
+
+- Show the current desktop, empty desktops, and occupied desktops
+- Show the date, time, volume, CPU statistics, and other information
+- Show the current playing song or anything else you want
+
+You should not use polybar if:
+
+- You already use a desktop environment that has an information panel
+
+[polybar]: https://github.com/jaagr/polybar
diff --git a/rtv/README.md b/rtv/README.md
new file mode 100644
index 00000000..aeb5a10a
--- /dev/null
+++ b/rtv/README.md
@@ -0,0 +1,17 @@
+# rtv
+
+[rtv][rtv] is a reddit browser for your terminal.
+
+## Use Cases
+
+rtv can be used to:
+
+- Ignore busy images or other media and focus on the content
+- Always have a reddit theme consistent with your setup
+- Use reddit without leaving the terminal, even through ttys
+
+You should not use rtv if:
+
+- You don't use reddit
+
+[rtv]: https://github.com/michael-lazar/rtv