Update documentation

Author: andreztz

README.md

@@ -3,10 +3,6 @@
 ![](header.png)
 
 
-
-
-
-
 ## Installation
 
 ```sh
@@ -17,21 +13,21 @@
 
 #### Ubuntu
 
-```
-$ sudo apt install libcairo2-dev libgirepository1.0-dev
+```sh
+sudo apt install libcairo2-dev libgirepository1.0-dev
 ```
 #### Arch Linux
 
-```
-$ sudo pacman -S gobject-introspection
+```sh
+sudo pacman -S gobject-introspection
 ```
 
 
 ## Usage example
 
 ```python
     from notify import notification
-    notification('body message', title='optinal')
+    notification('summary text', message='message body', app_name='myapp')
 ```
 
 
@@ -42,7 +38,7 @@ $ sudo pacman -S gobject-introspection
     cd notify-send
     python -m venv venv
     source venv/bin/activate
-    pip install -e .
+    pip install -e .[dev]
 ```
 
 

docs/api.md

@@ -1,38 +1,44 @@
-
 ## `Notification`
 
-Displays a notification.
 
+Displays a notification.
 
 **Paramters:**
 
-| Name     | type | description                                                  |
+| Name     | Type | Description                                                  |
 | ---------|------|--------------------------------------------------------------|
-| title    | str  | The summary text (optional).                                 |
-| message  | str  | The message body                                             |
+| summary  | str  | The summary text                                             |
+| message  | str  | The message body (optional)                                  |
+| timeout  | int  | Notification length in milliseconds (optional)               |
+| app_name | str  | Caller app name                                              |
 |\*\*kwargs|      | Additional arguments (optional)                              |
 
+
 ## Linux
 
-This module contains the code for the notification using the Gtk api.
+This module contains the code for the notification using Gtk api.
+
 
 ### `LinuxNotification`
 
+
 Displays a notification using the Gtk API.
 
 **Paramters:**
 
-| Name     |  Type     | Description                                           |
-| ---------|-----------|------------------------                               |
-| app_name | str       | The application name to use for this notification.    |
-| title    | str       | The summary text                                      |
-| message  | str       | The message body text                                 |
-| image    | str       | The icon filename or icon theme-compliant name        |
+| Name     |  Type     | Description                                    |
+| ---------|-----------|------------------------------------------------|
+| summary  | str       | The summary text                               |
+| message  | str       | The message body (optional)                    |
+| timeout  | int       | The timeout in milliseconds (optional)         |
+| app_name | str       | Caller app name                                |
+| image    | str       | The icon filename or icon theme-compliant name |
 
 
 ## Windows
 
-This module contains the code for the notification using the Win32 api.
+
+This module contains the code for the notification using Win32 api.
 
 
 ### `Win32Notification`
@@ -44,10 +50,7 @@ Displays a notification using the Win32 API.
 
 | Name     |  Type     | Description                                           |
 | ---------|-----------|-------------------------------------------------------|
+| summary  | str       | The summary text                                      |
+| message  | str       | The message body (optional)                           |
+| timeout  | int       | Timeout in milliseconds (optional)                    |
 | tip      | str       | Tooltip text (optional)                               |
-| timeout  | int       | Timeout for ballon tooltip in milliseconds (optional) |
-| title    | str       | Title for ballon tooltip (optional)                   |
-| message  | str       | Balloon tooltip text (optional)                       |
-
-
-

docs/index.md

@@ -2,20 +2,34 @@
 
 Displays a notification suitable for the platform being run on.
 
+## Example
+
+```python
+from notify import notification
+notification('summary text', message='message body', app_name='myapp')
+```
 
 ## Installation
 
 ```bash
 $ pip install notify-send
 ```
 
-## Example
+### Prerequisites
 
-```python
-from notify import notification
-notification('what you want said', title=':)')
+#### Ubunut
+
+```
+$ sudo apt install libcairo2-dev libgirepository1.0-dev
 ```
 
+#### Arch Linux
+
+```
+$ sudo pacman -S gobject-introspection
+```
+
+
 * [Notification](api.md#notification)
 * [Notification Linux](api.md#linux)
 * [Notification Windows](api.md#windows)

mkdocs.yml

@@ -1,8 +1,9 @@
 site_name: Notify-Send
 
 theme:
-  name: "material"
+  name: material
 
 plugins:
   - search
   - mkdocstrings
+