From c651145cd1e2877e93dd78449bf4946d4386f7b7 Mon Sep 17 00:00:00 2001
From: Eric Evenchick <eric@evenchick.com>
Date: Sat, 16 Jan 2016 16:59:56 -0500
Subject: [PATCH] added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb37437
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# CANtact-app
+
+CANtact-app is an open source software tool for interfacing with Controller Area
+Network systems from the desktop. It is primarily intended to be used with the
+[CANtact hardware](https://github.com/linklayer/cantact-hw), but should work
+with any device that uses the LAWICEL protocol.
+
+## Features
+- Display of CAN bus trace
+- Live display, showing the most recent data for each frame
+- Simple transmission of CAN frames
+- Javascript scripting interface
+
+## TODO
+- ISOTP, OBD-II, and UDS protocol implementations (in progress)
+- Saving, loading, and playing of CAN logs
+- CAN databases and signal decoding
+- etc...