From 673de87e12e81c9a2178d6972fcc40cfaad307fc Mon Sep 17 00:00:00 2001 From: Rupus Reinefjord Date: Mon, 27 Jan 2020 08:29:11 +0100 Subject: [PATCH] Improve README readability --- README.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 4fa99ff..bfb3d80 100644 --- a/README.md +++ b/README.md @@ -6,20 +6,30 @@ Actions. ## Inputs -* `apiUsername` - **Required**: Your 46elks API username, available at - the [46elks dashboard](https://46elks.com/account). -* `apiPassword` - **Required**: Your 46elks API password, also available - from the 46elks dashboard. -* `from` - **Required**: The number or alpha numerical sender ID you - would like to send the SMS from. Defaults to `"ElkAction"`. -* `to` - **Required**: The number you would like to send the SMS to. - Defaults to `+4670000000`, which does not actually send a message and - is free, but will show up in your logs. -* `message` - **Required**: The message to send with the SMS. +### `apiUsername` +**Required**: Your 46elks API username, available at the +[46elks dashboard](https://46elks.com/account). + +### `apiPassword` +**Required**: Your 46elks API password, also available from the 46elks +dashboard. + +### `from` +**Required**: The number or alpha numerical sender ID you would like to +send the SMS from. Defaults to `"ElkAction"`. + +### `to` +**Required**: The number you would like to send the SMS to. Defaults to +`+4670000000`, which does not actually send a message and is free, but +will show up in your logs. + +### `message` +**Required**: The message to send with the SMS. ## Outputs -* `id` - The 46elks SMS ID of the SMS that was created. +### `id` +The 46elks SMS ID of the SMS that was created. ## Usage