From 975ae576a3d1dac089abcb0c38c337c8f533afdb Mon Sep 17 00:00:00 2001
From: Jason Hiser <jdhiser@gmail.com>
Date: Fri, 27 Jul 2018 18:35:12 +0000
Subject: [PATCH] readme

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9972a0b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+
+This is a library to parse ELF's exception handling information out of its binary form and into it's "parse tree" form.
+
+The API is documented in the include directory.  The source tree is complicated and understanding it should not be necessary.
+
+The test directory contains a simple example of how to use the API.
+
+Notes:
+
+1. Compilation requires C++11 or later.
+1. Additional documentation will be provided in later versions 
+1. API is incomplete and untested in some areas.  Future versions will improve stability.
-- 
GitLab