From 5c04a58082c6979750129d06f553792a6082ffa4 Mon Sep 17 00:00:00 2001
From: Donovan Glover <donovan@dglover.co>
Date: Sun, 18 Nov 2018 13:22:48 -0500
Subject: [PATCH] docs: Add READMEs for compton, dunst, and zathura

Since my dotfiles are now sorted by individual programs instead of in
groups, I'm trying a new README format. This format should provide more
useful information and be easier to read as well.
---
 compton/README.md | 18 ++++++++++++++++++
 dunst/README.md   | 16 ++++++++++++++++
 zathura/README.md | 19 +++++++++++++++++++
 3 files changed, 53 insertions(+)
 create mode 100644 compton/README.md
 create mode 100644 dunst/README.md
 create mode 100644 zathura/README.md

diff --git a/compton/README.md b/compton/README.md
new file mode 100644
index 00000000..fc93c831
--- /dev/null
+++ b/compton/README.md
@@ -0,0 +1,18 @@
+# compton
+
+[compton][compton] is a desktop compositor for X11.
+
+## Use Cases
+
+compton can be used to:
+
+- Reduce screen tear in certain environments
+- Add elementary animations such as fading to your desktop
+- Add shadows to your desktop
+
+You should not use compton if:
+
+- Your window manager or desktop environment already has a compositor
+- You are not using X11
+
+[compton]: https://github.com/yshui/compton
diff --git a/dunst/README.md b/dunst/README.md
new file mode 100644
index 00000000..b9894a8d
--- /dev/null
+++ b/dunst/README.md
@@ -0,0 +1,16 @@
+# dunst
+
+[dunst][dunst] is used to display notifications on your desktop.
+
+## Use Cases
+
+dunst can be used to:
+
+- Display messages sent with `notify-send`
+- Strategically add notifications to your rice screenshots
+
+You should not use dunst if:
+
+- Your desktop environment already includes a notification daemon
+
+[dunst]: https://github.com/dunst-project/dunst
diff --git a/zathura/README.md b/zathura/README.md
new file mode 100644
index 00000000..0687da04
--- /dev/null
+++ b/zathura/README.md
@@ -0,0 +1,19 @@
+# zathura
+
+[zathura][zathura] is a document viewer that displays PDFs and other files with no GUI.
+
+## Use Cases
+
+zathura can be used to:
+
+- View .pdf and .djvu files
+- View documents with the same color scheme as the rest of your setup
+- Recolor a PDF file with a dark background and light text
+- Strategically add documents to your rice screenshots
+
+You should not use zathura if:
+
+- You want to see page thumbnails
+- You want to see and click on GUI components
+
+[zathura]: https://github.com/pwmt/zathura