Skip to content

Commit

Permalink
Added a readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
remcos committed Apr 14, 2017
1 parent e8c15bb commit 35501d2
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Documentation

## Description
This widget allows you to send a pre-filled HTML email from your phone. It will let you choose which native app to use and open an email object in that application.

## Typical usage scenario
* A user uses the contact button in a hybrid app, which should create a predefined e-mail with rich formatting.

## Features and limitations
* The e-mail can be send using the mobile app of your choice (both iOS and Android).
* The To, CC, Subject and Body field can be filled in.

## Configuration
1. Create an email entity, containing at least To, CC, Subject and Body attributes.
2. Create a forward-screen, which takes an email object as page parameter, containing the widget in the data view.
3. Configure the widget to pass the correct attribute values.

0 comments on commit 35501d2

Please sign in to comment.