From 1844166cc992d20e6cbc12d104f3deada99a785f Mon Sep 17 00:00:00 2001
From: Ammar Askar <ammar@ammaraskar.com>
Date: Sun, 16 Feb 2020 06:40:56 -0500
Subject: [PATCH] Add some documentation

---
 README.md | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 50f451d..4f81d9b 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,20 @@
 # sphinx-problem-matcher
-Github Action problem matcher for the Sphinx documentation tool
+
+This action adds a problem matcher that catches Sphinx warnings to show them
+neatly inside your pull request like this:
+
+![Example Screenshot](https://i.imgur.com/xkUMS1a.png)
+
+The common usage of this will be like so:
+
+```yaml
+    - uses: ammaraskar/sphinx-problem-matcher@master
+    - name: "Build docs"
+      run: |
+        cd docs
+        make html
+```
+
+That is, simply run this action before building your docs.
+
+**Note: this does not handle actually building your docs.**