From 4b34cf1ffbea982001d2ec22c7035154696a538b Mon Sep 17 00:00:00 2001 From: Jia Hao Date: Sun, 5 Jul 2015 20:44:18 +0800 Subject: [PATCH] Updated documentation --- README.md | 14 +++++++++----- usage.txt | 2 +- 2 files changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4a1d6ce..551a25c 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ## Introduction [![NPM](https://nodei.co/npm/nativefier.png)](https://nodei.co/npm/nativefier/) -Package and wraps a single-page web app in an [electron](http://electron.atom.io) OS executable (.app, .exe, etc) via the command line. +Packages and wraps a single-page web app in an [Electron](http://electron.atom.io) OS executable (.app, .exe, etc) via the command line. -Simply a fork with a small layer of abstraction on top of [electron-packager](https://github.com/maxogden/electron-packager) for the CLI. +Simply a fork with a small layer of abstraction on top of [electron-packager](https://github.com/maxogden/electron-packager) for the command line. I did this because I was tired of having to `⌘-tab or alt-tab` to my browser and then search through the numerous tabs open when I was using [Whatsapp Web](http://web.whatsapp.com) or [Facebook Messenger](http://messenger.com). @@ -13,6 +13,9 @@ I did this because I was tired of having to `⌘-tab or alt-tab` to my browser a A back button is intentionally not provided because the tool is designed for single page apps. However, if desired, an executable can built for any url, and simply pressing the `backspace` key will take the user back to the previous page. + +*Tested only on OSX* + ## Installation ```bash @@ -22,7 +25,7 @@ npm install nativefier -g ## Usage -```css +``` Usage: nativefier --target= --platform= --arch= --version= Required options @@ -39,7 +42,7 @@ Optional options all equivalent to --platform=all --arch=all out the dir to put the app into at the end. defaults to current working dir -icon the icon file to use as the icon for the app +icon the icon file to use as the icon for the app (should be a .icns file on OSX) app-bundle-id bundle identifier to use in the app plist app-version version to set for the app helper-bundle-id bundle identifier to use in the app helper plist @@ -74,4 +77,5 @@ $ nativefier Messenger --platform=darwin --arch=x64 --version=0.29.1 --target='h ## Todo - Set the app icon from a url in the CLI -- Set the app window dimensions from the CLI \ No newline at end of file +- Set the app window dimensions from the CLI +- Dock badges \ No newline at end of file diff --git a/usage.txt b/usage.txt index 797417c..5df0f60 100644 --- a/usage.txt +++ b/usage.txt @@ -14,7 +14,7 @@ Optional options all equivalent to --platform=all --arch=all out the dir to put the app into at the end. defaults to current working dir -icon the icon file to use as the icon for the app +icon the icon file to use as the icon for the app (should be a .icns file on OSX) app-bundle-id bundle identifier to use in the app plist app-version version to set for the app helper-bundle-id bundle identifier to use in the app helper plist