From 6f4b62fc8f04556f88a96b8d0b512c5908744833 Mon Sep 17 00:00:00 2001
From: Liz Rice <liz@lizrice.com>
Date: Sun, 5 Nov 2017 13:01:56 +0100
Subject: [PATCH] Update README.md

---
 README.md | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index fbf1456..c0ec696 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,7 @@
-# debugger-from-scratch
\ No newline at end of file
+# debugger-from-scratch
+
+This is a very simple debugger that shows how ptrace can be used to set breakpoints and generate stack traces in a target process. You can choose where to breakpoint the target process, and single step or continue to the next breakpoint (or target exit). 
+
+Big caveat: it assumes there is only one file in the target! 
+
+I fully expect this only to work on Linux.