docs: update README

Author: trueChazza

README.md

@@ -13,7 +13,7 @@ Simple web push library for Elixir
     <img alt="Hex Version" src="https://img.shields.io/hexpm/v/web_push_elixir.svg">
 </a>
 <a href="https://hexdocs.pm/web_push_elixir">
-    <img alt="Hex Docs" src="http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat">
+    <img alt="Hex Docs" src="http://img.shields.io/badge/api-docs-blue.svg?style=flat">
 </a>
 
 
@@ -39,7 +39,7 @@ end
 mix generate.vapid.keys
 ```
 
-3. Set your environment variables for your keys:
+3. Set environment variables for your generated keys:
 
 ```yaml
 environment:
@@ -50,10 +50,10 @@ environment:
 
 ## Usage
 
-`WebPushElixir` provides a simple public API `send_notification/2` that accepts 2 arguments:
+`WebPushElixir` provides a simple `send_notification/2` function that accepts 2 arguments:
 
-* `subscription`: is the subscription information received from the client.
-* `message`: is a message string.
+* `subscription`: the subscription information received from the client ([example](https://midarrlabs.github.io/web-push-elixir/))
+* `message`: the message string.
 
 ```elixir
 subscription = '{"endpoint":"https://some-push-service","keys":{"p256dh":"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=","auth":"tBHItJI5svbpez7KI4CCXg=="}}'
@@ -62,7 +62,7 @@ message = "Some message"
 WebPushElixir.send_notification(subscription, message)
 ```
 
-For more information on how to subscribe a client, permission UX and more - have a look at [https://web.dev/notifications/](https://web.dev/notifications/)
+For more information on how to subscribe a client, permission UX and more - take a look at [https://web.dev/notifications/](https://web.dev/notifications/)
 
 ## Run tests
 

lib/web_push_elixir.ex

@@ -100,8 +100,8 @@ defmodule WebPushElixir do
 
   ## Arguments
 
-  * `subscription` is the subscription information received from the client. Accepted example: `'{"endpoint":"https://some-push-service","keys":{"p256dh":"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=","auth":"tBHItJI5svbpez7KI4CCXg=="}}'`
-  * `message` is a message string.
+  * `subscription` the subscription information received from the client. Accepted example: `'{"endpoint":"https://some-push-service","keys":{"p256dh":"BNcRdreALRFXTkOOUHK1EtK2wtaz5Ry4YfYCA_0QTpQtUbVlUls0VJXg7A8u-Ts1XbjhazAkj7I99e8QcYP7DkM=","auth":"tBHItJI5svbpez7KI4CCXg=="}}'`
+  * `message` the message string.
 
   ## Return value