CSIT-1110: Add files for PyPI migration
[csit.git] / resources / tools / presentation / new / jumpavg / README.rst
diff --git a/resources/tools/presentation/new/jumpavg/README.rst b/resources/tools/presentation/new/jumpavg/README.rst
new file mode 100644 (file)
index 0000000..732af5e
--- /dev/null
@@ -0,0 +1,26 @@
+Jumpavg library
+===============
+
+Origins
+-------
+
+This library was developed as anomaly detection logic
+for PAL_ (Presentation and Analysis Layer)
+of CSIT_ (Continuous System and Integration Testing)
+project of fd.io_ (Fast Data), one of LFN_
+(Linux Foundation Networking) projects.
+
+In order to make this code available in PyPI_ (Python Package Index),
+and to avoid rigid release cadence of CSIT,
+the library has been moved into this standalone project.
+
+Usage
+-----
+
+TODO.
+
+.. _PAL: https://wiki.fd.io/view/CSIT/Design_Optimizations#Presentation_and_Analytics_Layer
+.. _CSIT: https://wiki.fd.io/view/CSIT
+.. _fd.io: https://fd.io/
+.. _LFN: https://www.linuxfoundation.org/projects/networking/
+.. _PyPI: https://pypi.org/