From efea4d2763c27516854548d859f9ad8e761a5ccf Mon Sep 17 00:00:00 2001
From: Swarup Nayak <swarupnpvt@gmail.com>
Date: Tue, 20 Mar 2018 17:34:13 +0530
Subject: Added readme and release files.

Change-Id: I1f1c5ad27d38549543e19b0b731fa72f39d02cb4
Signed-off-by: Swarup Nayak <swarupnpvt@gmail.com>
---
 README.md  | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 RELEASE.md | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 82 insertions(+)
 create mode 100644 README.md
 create mode 100644 RELEASE.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a3005e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+# 1.  Introduction:
+
+# ![nStack_Architecture](resources/nStack_Architecture.png "nStack_Architecture")
+
+DMM (Dual Mode, Multi-protocol, Multi-instance) is a framework between applications
+and transport layer of networking stack. This framework can hosts different types of
+networking stack instances operating on different domains (kernel/user-space) or even with
+different protocol suites (TCP/IP, RDMA, or others). Application can use different type of
+protocol stack implementations based on functional/performance requirements.
+
+
+# 2.  History:
+Emerging applications are bringing extremely high-performance requirements to the
+network system. Eg. AR/VR, IOT etc. And Many of them coming with their unique demand
+of QOS/SLA. Some application need low latency network, some need high reliability etc.
+Though such performance targets should be required for the complete communication system,
+the transport layer protocols play a key role and encountered a relatively higher
+challenge, because traditionally the TCP-based transport layer exploits the “best-effort” principle
+and provides no performance guarantees in its nature. However, as Internet applications rapidly
+grow and diversify, an all-powerful or one-fits-all protocol or algorithm becomes less feasible.
+Thus, the traditional single-instance TCP-based network stack bears great challenges when
+serving many applications with different QoS/SLA requirements  simultaneously on the
+same platform. Also Moving the networking stack out of the kernel is an obvious trend in both
+the industry and literature. Technologies like DPDK, etc improving performance of network
+stack, by bypassing the kernel, avoiding context-switching and data copies, as well as providing
+a complete set of packet-processing acceleration libraries. Keeping above trends in mind the
+DMM/nStack provides a framework where, system operators can plug in dedicated types of
+networking stack instances according to performance and/or functional requirements from
+the user space applications. Application doesn't have to worry about change their transport
+layer API. A lightweight nStack management daemon is responsible for maintaining the stack
+instances and the app/socket-to-stack-mappings, which are provided via the orchestration
+/management interface. So DMM provide a framework which can hide all the complexity of
+different transport layer protocol and also provide the flexibility to choose a protocol stack
+from manybased on functional/performance requirements.
+
+
+# 3.  Quick Start
+Refer doc/Build_DMM.md 
+
+
+# 5. More Information
+
+- https://wiki.fd.io/view/DMM
+- https://wiki.fd.io/view/Project_Proposals/DMM
+- Enabling “Protocol Routing”: Revisiting Transport Layer Protocol Design in Internet
+Communications(http://ieeexplore.ieee.org/document/8114687/)
+
+
diff --git a/RELEASE.md b/RELEASE.md
new file mode 100644
index 0000000..c678b3e
--- /dev/null
+++ b/RELEASE.md
@@ -0,0 +1,34 @@
+# Release Notes    {#release_notes}
+
+* @subpage release_notes_1807
+* @subpage release_notes_1804
+
+@page release_notes_1807 Release notes for DMM 18.07
+
+TBD
+
+@page release_notes_1804 Release notes for VPP 18.04
+
+
+## Features
+- Initial commit
+- nsocket API support
+- nstack plugin
+- DPDK HAL
+- Kernel mode stack support
+- Sample APP (app_example)
+- Blackbox CI
+- Supported documents(doc)
+
+## Known issues
+
+For the full list of issues please refer to  FD.io/DMM [JIRA](https://jira.fd.io/projects/DMM/issues/?filter=allopenissues).
+
+## Issues fixed
+
+For the full list of fixed issues please refer to:
+- FD.io/DMM [JIRA](https://jira.fd.io/projects/DMM/issues/?filter=allopenissues)
+- git [commit log](https://git.fd.io/dmm/)
+
+## API changes
+None
-- 
cgit 1.2.3-korg