diff --git a/README.md b/README.md index f8b96c7..56dd40d 100644 --- a/README.md +++ b/README.md @@ -8,3 +8,5 @@ addon | version | summary --- | --- | --- [muk_web_client](muk_web_client/) | 11.0 | Odoo Web Client Extension +[muk_web_client_refresh](muk_web_client_refresh/) | 11.0 | Web Client Refresh + diff --git a/muk_web_client_refresh/README.md b/muk_web_client_refresh/README.md index b72809d..2b83696 100644 --- a/muk_web_client_refresh/README.md +++ b/muk_web_client_refresh/README.md @@ -1,3 +1,17 @@ # MuK Web Client Refresh -Adds a refresh channel to the web client. By sending a message to this channel, the corresponding view is reloaded. \ No newline at end of file +Adds a "refresh" channel to the web client, +which can be used to trigger a view refresh without refreshing the +browser itself. Furthermore, it allows the user the creation of +"refresh" rules. These rules can be applied to any Odoo model and +trigger a refresh either on create, write or unlink. + +## Python Support + +Besides creating a "refresh" rule, a view refresh can be triggered +manually via python. This can be useful if there is a need for a +view refresh on other operations like an action. + +```python +self.env['bus.bus'].sendone('refresh', self._name) +``` \ No newline at end of file