Update contents of README.md

The "directory organization" section is outdated and we are missing
a brief description of the project. Get rid of the outdated information,
add a general description.

JIRA: BGPCEP-1025
Change-Id: Icb6b3de8336938c111cdb3d0a5c18395d921797b
Signed-off-by: Šimon Ukuš <simon.ukus@pantheon.tech>

diff --git a/README.md b/README.md
index bfaa643b2ace5141baac30ce1aec719e1c4c3de0..738a2fa94586deb07836124dfc601e72b479e5a2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,17 @@
-Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
+#### Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
 
 This program and the accompanying materials are made available under the
 terms of the Eclipse Public License v1.0 which accompanies this distribution,
 and is available at http://www.eclipse.org/legal/epl-v10.html
 
-## DIRECTORY ORGANIZATION
+# BGPCEP
 
-* src/site:
-    * maven site plugin templates
+BGPCEP project is an effort to bring two south-bound plugins into the controller:
+one for supporting BGP Linkstate Distribution as a source of L3 topology information,
+the other one to add support for Path Computation Element Protocol as a way to instantiate paths
+into the underlying network.
 
-* mockito-configuration:
-    * default configuration of mockito framework
+## DIRECTORY ORGANIZATION
 
 * concepts:
     * Common networking concepts, shared between the protocols
@@ -24,12 +25,6 @@ and is available at http://www.eclipse.org/legal/epl-v10.html
 * pcep:
     * PCEP-related artifacts
 
-* pcep/pcepy:
-    * Python PCEP library
-
-* pcep/pcepdump:
-    * Python-based PCEP listener and debug tool
-
 * rsvp:
     * RSVP modeling concepts (needed by pcep)