From 4d08f15fe4fcdec0e84d67924447cbcbce73e67e Mon Sep 17 00:00:00 2001 From: bartonstee <66774568+bartonstee@users.noreply.github.com> Date: Mon, 21 Dec 2020 09:29:39 +0100 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++++++++++-------- 1 file changed, 16 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 054984f..6fd2b5c 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ ## MountEvent -[Perform an action on widget mount.] - -## Features -[feature highlights] +Widget which will execute an action as soon as widget is mounted ## Usage -[step by step instructions] +For development: + +Create customwidgets folder in root of project directory +Git clone this repo into customwidgets folder +Open command prompt in cloned folder +npm i +npm run dev / npm run build +Widget can now be used inside Mendix. + +For plain usage: + +Copy MPK file in releases to widgets directory. ## Demo project -[link to sandbox] +Not available yet. ## Issues, suggestions and feature requests -[link to GitHub issues] +https://github.com/IncentroBA/mountevent/issues ## Development and contribution -[specify contribute] +Bart Onstee