diff --git a/README b/README new file mode 100644 index 0000000..d47294a --- /dev/null +++ b/README @@ -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.