add README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..f81b13b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,42 @@
+#ti2
+`ti2` is a tool to generate a network diagram in the OS(Linux)
+from os environment.
+
+##Features
+* Collect the network information for the OS (Open vSwitch, Linux Bridge, libvirt)
+* Generate the input format of Graph-Easy (basic feature).
+  Graph-Easy http://search.cpan.org/~shlomif/Graph-Easy-0.72/lib/Graph/Easy.pm
+* Generate the springy HTML format.
+  Springy https://github.com/dhotson/springy
+
+##Setup
+
+###by tar ball
+Extract the tar file::
+
+   $ tar xfz ti2-x.x.tar.gz
+
+###use
+   $ cd ti2-x.x
+   $ ./ti2.py
+
+##Requirements
+* Python 2.6 or later
+* Python Libvirt Library 0.9.10 or later.
+* Python Flask Library 0.10.1 or later.
+* Python SSH Library 1.8.0 or later. (or Paramiko Library 1.7.5 or later.)
+
+
+##License
+Apache License 2.0
+
+
+##History
+1.2 (2013-10-14)
+------------------
+* public release
+
+1.1 (2013-03-06)
+------------------
+* first release
+