From 3fb4cdaba4ae5f7b630a4fbffc3faed919e3b46b Mon Sep 17 00:00:00 2001
From: Joey <jyapayne@gmail.com>
Date: Sun, 9 Feb 2020 10:39:46 -0700
Subject: [PATCH] Update README.md

---
 README.md | 56 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 56 insertions(+)

diff --git a/README.md b/README.md
index 7c0017b..6653c83 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,58 @@
 # mort
 A dead code locator for Nim
+
+## Usage
+
+Simply use the `findDeadCode` macro on your code, shown below, then call either or both of `printCodeUsage` or `printDeadCode`.
+
+```nim
+import mort
+
+findDeadCode:
+  # ... insert Nim code here
+  discard
+
+# OR
+
+proc myNimProc() {.findDeadCode.} =
+  # .. insert Nim code here
+  discard
+  
+  
+proc main() =
+  # Call your proc/code that you want to be logged
+  myNimProc()
+  
+  # then call ``printCodeUsage`` and/or ``printDeadCode``
+  printCodeUsage()
+  printDeadCode()
+
+main()
+```
+
+Then compile your code with the `-d:findDeadCode` compiler flag to enable finding dead code.
+
+## Example usage
+
+```bash
+nim c -r -d:findDeadCode tests/testmort.nim
+```
+
+Output:
+
+```
+6: 2
+8: 1
+10: 20
+11: 0
+13: 4
+18: 16
+22: 2
+25: 0
+
+Dead code found in /Users/joey/Projects/mort/tests/testmort.nim
+at line 11
+
+Dead code found in /Users/joey/Projects/mort/tests/testmort.nim
+at line 25
+```