Add web_notify addons

4 files changed, 57 insertions, 0 deletions

diff --git a/web_notify/readme/CONTRIBUTORS.rst b/web_notify/readme/CONTRIBUTORS.rst
new file mode 100644
index 0000000..7a21d19
--- /dev/null
+++ b/web_notify/readme/CONTRIBUTORS.rst
@@ -0,0 +1,5 @@
+* Laurent Mignon <laurent.mignon@acsone.eu>
+* Serpent Consulting Services Pvt. Ltd.<jay.vora@serpentcs.com>
+* Aitor Bouzas <aitor.bouzas@adaptivecity.com>
+* Shepilov Vladislav <shepilov.v@protonmail.com>
+* Kevin Khao <kevin.khao@akretion.com>
diff --git a/web_notify/readme/DESCRIPTION.rst b/web_notify/readme/DESCRIPTION.rst
new file mode 100644
index 0000000..2cd8978
--- /dev/null
+++ b/web_notify/readme/DESCRIPTION.rst
@@ -0,0 +1,10 @@
+Send instant notification messages to the user in live.
+
+This technical module allows you to send instant notification messages from the server to the user in live.
+Two kinds of notification are supported.
+
+* Success: Displayed in a `success` theme color flying popup div
+* Danger: Displayed in a `danger` theme color flying popup div
+* Warning: Displayed in a `warning` theme color flying popup div
+* Information: Displayed in a `info` theme color flying popup div
+* Default: Displayed in a `default` theme color flying popup div
diff --git a/web_notify/readme/INSTALL.rst b/web_notify/readme/INSTALL.rst
new file mode 100644
index 0000000..b47aebb
--- /dev/null
+++ b/web_notify/readme/INSTALL.rst
@@ -0,0 +1 @@
+This module is based on the Instant Messaging Bus. To work properly, the server must be launched in gevent mode.
diff --git a/web_notify/readme/USAGE.rst b/web_notify/readme/USAGE.rst
new file mode 100644
index 0000000..e25ef76
--- /dev/null
+++ b/web_notify/readme/USAGE.rst
@@ -0,0 +1,41 @@
+
+To send a notification to the user you just need to call one of the new methods defined on res.users:
+
+.. code-block:: python
+
+   self.env.user.notify_success(message='My success message')
+
+or
+
+.. code-block:: python
+
+   self.env.user.notify_danger(message='My danger message')
+
+or
+
+.. code-block:: python
+
+   self.env.user.notify_warning(message='My warning message')
+
+or
+
+.. code-block:: python
+
+   self.env.user.notify_info(message='My information message')
+
+or
+
+.. code-block:: python
+
+   self.env.user.notify_default(message='My default message')
+
+.. figure:: static/description/notifications_screenshot.png
+   :scale: 80 %
+   :alt: Sample notifications
+
+You can test the behaviour of the notifications by installing this module in a demo database.
+Access the users form through Settings -> Users & Companies. You'll see a tab called "Test web notify", here you'll find two buttons that'll allow you test the module.
+
+.. figure:: static/description/test_notifications_demo.png
+   :scale: 80 %
+   :alt: Sample notifications