Add web_notify addons

1 files changed, 41 insertions, 0 deletions

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