diff --git a/README.md b/README.md index f313ac6..137c4ed 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ ## Backhandler -[Disregard back events on page] - -## Features -[feature highlights] +Widget to disregard back events on page when using Mendix Native. ## 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/backhandler/issues ## Development and contribution -[specify contribute] +N/A