use markdown for the README - updated that one with more deatils and links

[sfa.git] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..77e9e9b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+Purpose
+===
+
+This software implements a wrapper for the SFA (Slice-based Federation
+Architecture) that allows networking testbeds to interoperate in terms
+of exposing and provisioning resources. It comes with some drivers for
+a few testbeds, notably PlanetLab and IotLab.
+
+References
+====
+ * [This page](http://sfawrap.info) describes the motivation behind this software
+ * Refer to [this trac page](http://svn.planet-lab.org/wiki/SFATutorial#SFATutorial) for installing and using this software
+ * The GENI community has  [a page on the Aggregate API](http://groups.geni.net/geni/wiki/GeniApi)
+
+