docs/README.txt
changeset 17 d0c10078c618
parent 0 1cc388b5cf69
child 29 76e8fa9c5516
--- a/docs/README.txt	Mon Nov 25 13:40:03 2019 +0100
+++ b/docs/README.txt	Mon Nov 25 13:41:08 2019 +0100
@@ -1,3 +1,25 @@
+=================
+PyAMS_apm package
+=================
 
-PyAMS APM
-=========
+.. contents::
+
+
+What is PyAMS
+=============
+
+PyAMS (Pyramid Application Management Suite) is a small suite of packages written for applications
+and content management with the Pyramid framework.
+
+**PyAMS** is actually mainly used to manage web sites through content management applications (CMS),
+see PyAMS_content package), but many features are generic and can be used inside any kind of web
+application.
+
+
+What is PyAMS_apm ?
+===================
+
+APM in an Elasticsearch module which can be used to monitor applications performances.
+
+This package allows to integrate any Pyramid application with APM, providing a custom tween.
+It also add instrumentation of several Python packages, like Chameleon or LDAP3.