add a README file

2013-05-29 18:42:30 +02:00 · 2013-05-29 18:42:30 +02:00 · f62aa82eee
parent 3047160255
commit f62aa82eee
1 changed files with 22 additions and 0 deletions
--- a/22
+++ b/22
@ -0,0 +1,22 @@
+Portail-citoyen Announces
+-------------------------
+
+This application is modeled upong the announce functionnality of the
+Au-Quotidien plateform.
+
+Settings
+--------
+
+ANNOUNCES_TRANSPORTS:
+
+a dictionary of key and class-path listing backend for sending announces.
+Default is::
+
+    {
+            'email': 'portail_citoyen_announces.transports.EmailTransport',
+    }
+
+ANNOUNCES_DEFAULT_FROM_EMAIL:
+
+the default email to user for sending announces, if not defined,
+DEFAULT_FROM_EMAIL is used.