1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..58f3c3a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,9 @@
+chisel3 is a new FIRRTL based chisel
+
+the current backward incompatiabilities with chisel 2.x are:
+
+val wire = Bits(width = 15)
+
+is
+
+val wire = Wire(Bits(width = 15))