From 9e8db59d38651b8ae72ba60c4962b40b3e2eb9e2 Mon Sep 17 00:00:00 2001 From: Adasauce Date: Thu, 5 Nov 2020 16:49:24 -0400 Subject: [PATCH] docs: add usage output to the readme to give an idea. --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 535a2fe..c99a997 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,20 @@ # mknative -Some wrappers around nativefier. +Some bash wrappers around nativefier to generate standalone electron apps. + +## Usage + +``` +mknative +======== +Basic Usage: $ mknative [-u] -n NativeExample -s https://example.com +--------------------------------------------------------------------------- + -n NativeExample installed application name (basically an id) + -s https://example.com website address + -u [optional] uninstall + -i example.com [optional] domain name to fetch favicon from. + -e '--extra-args' [optional] pass some extra args to nativefier build. +``` ## Installation