Add README file for initialization

Signed-off-by: Hongjun Ni <hongjun.ni@intel.com>
Change-Id: I782abbca992f0a2ff35423c90357b2ad6b15ba94

1 files changed, 28 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bb6f9b0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+UDPI
+========================
+
+## Introduction
+
+The UDPI (Universal Deep Packet Inspection) project is a reference framework to build a high performance solution
+for Deep Packet Inspection, integrated with the general purpose FD.io VPP stack.
+It leverages industry regex matching library to provide a rich set of features,
+which can be used in IPS/IDS, Web Firewall and similar applications.
+
+For more information on UDPI and its features please visit the
+[UDPI website](https://wiki.fd.io/view/UDPI)
+
+
+## Changes
+
+Details of the changes leading up to this version of UDPI can be found under
+@ref release notes.
+
+
+## Getting started
+
+Make sure you have added FD.io repository using https://packagecloud.io/fdio/release/
+installation script.
+You should have a sight on the release package, the package name may be different depending on the distribution.
+(ex: vpp-plugins.deb for VPP 19.01 and vpp-plugin-core.deb and vpp-plugin-dpdk.deb in 19.04)
+
+