Skip to content

Commit

Permalink
Improve README readability
Browse files Browse the repository at this point in the history
  • Loading branch information
reinefjord committed Jan 27, 2020
1 parent 8c41c66 commit 673de87
Showing 1 changed file with 21 additions and 11 deletions.
32 changes: 21 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 673de87

Please sign in to comment.