From 7ed39dc319bb82ebd0e55c532491a4acf94169f7 Mon Sep 17 00:00:00 2001
From: Gabriel Tofvesson <gabto095@student.liu.se>
Date: Thu, 16 Apr 2020 03:14:07 +0200
Subject: [PATCH] Create README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ef08331
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Beethoven: A library for making Java bytecode instrumentation easier
+
+The point of this library is to offer a simple, annotation-driven way to instrument classes.
+What this means is that a user of this library should never have to see
+so much as a byte. Everything should be abstracted to the level of classes,
+methods and fields.
+
+## Progress:
+
+* Injected methods
+
+* Target field accesses from injection class (non-primitive/reference)
+
+* Method calls and field acceses referencing injection class elements automatically redirected to target
+
+* Optional interface injection
+
+## TODO:
+
+* Target class method invocation
+
+* Support for target class primitive field access
+
+* Support for target class primitive return-value methods
+
+* Multiple injections per method
+
+* In-place method instruction injection
+
+* Better tests