Add README.rst (pypi)

Change-Id: I4248c86ee51b9458d367440670a0abaf3ec7c87f
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>

diff --git a/README.rst b/README.rst
new file mode 100644 (file)
index 0000000..44dd46c
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,23 @@
+Welcome!
+========
+
+Xtesting have leveraged on Functest efforts to provide a reference testing
+framework:
+
+  * Requirements Management: https://wiki.opnfv.org/display/functest/Requirements+management
+  * Docker Slicing: http://testresults.opnfv.org/functest/dockerslicing/
+  * Functest Framework: http://testresults.opnfv.org/functest/framework/
+
+Xtesting aims at allowing a smooth integration of new Functest Kubernetes
+testcases.
+
+But, more generally, it eases building any CI/CD toolchain for other
+domains than testing Virtualized Infrastructure Managers (VIM) such as
+`OpenStack <https://www.openstack.org/>`_.
+
+To learn more about Xtesting:
+
+  * Documentation: http://xtesting.readthedocs.io/en/latest/
+  * Gerrit: https://gerrit.opnfv.org/gerrit/#/q/project:functest-xtesting
+
+Get in touch via `email <mailto:opnfv-tech-discuss@lists.opnfv.org>`_.

diff --git a/setup.cfg b/setup.cfg
index fc6a092..865bfc4 100644 (file)
--- a/setup.cfg
+++ b/setup.cfg
@@ -1,5 +1,8 @@
 [metadata]
 name = xtesting
+summary = OPNFV reference testing framework
+description-file =
+    README.rst
 author = OPNFV
 author-email = opnfv-tech-discuss@lists.opnfv.org
 home-page = https://wiki.opnfv.org/display/functest