From 44a8517dd5567cf6ab1966e6c6f7915cdb50d62f Mon Sep 17 00:00:00 2001
From: Sravan Balaji <balajsra@umich.edu>
Date: Sat, 1 Aug 2020 23:14:32 -0400
Subject: [PATCH] README Update

- Add list of personal modifications
- Convert to markdown
---
 README    | 24 ------------------------
 README.md | 35 +++++++++++++++++++++++++++++++++++
 2 files changed, 35 insertions(+), 24 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index dcacd01..0000000
--- a/README
+++ /dev/null
@@ -1,24 +0,0 @@
-slock - simple screen locker
-============================
-simple screen locker utility for X.
-
-
-Requirements
-------------
-In order to build slock you need the Xlib header files.
-
-
-Installation
-------------
-Edit config.mk to match your local setup (slock is installed into
-the /usr/local namespace by default).
-
-Afterwards enter the following command to build and install slock
-(if necessary as root):
-
-    make clean install
-
-
-Running slock
--------------
-Simply invoke the 'slock' command. To get out of it, enter your password.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..de2cb38
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Sravan's slock - simple screen locker
+
+[slock](https://tools.suckless.org/slock/) is a simple screen locker utility for X.
+This is Sravan's fork of slock with patches and custom modifications.
+
+## slock Information
+
+### Requirements
+
+In order to build slock you need the Xlib header files.
+
+### Installation
+
+Edit config.mk to match your local setup (slock is installed into
+the /usr/local namespace by default).
+
+Afterwards enter the following command to build and install slock
+(if necessary as root):
+
+    make clean install
+
+### Running slock
+
+Simply invoke the 'slock' command. To get out of it, enter your password.
+
+## Personal Modifications
+
+### Patches
+
+* [blur pixelated screen](https://tools.suckless.org/slock/patches/blur-pixelated-screen/)
+* [dpms](https://tools.suckless.org/slock/patches/dpms/)
+
+### Modifications
+
+* Update user and group in config