octoleo/nativefier
2
2
Fork 0
mirror of https://github.com/Llewellynvdm/nativefier.git synced 2024-12-23 10:38:55 +00:00
Code Issues Releases Activity

Updated documentation

Browse Source
This commit is contained in:
Jia Hao 2015-07-05 20:44:18 +08:00
parent 247345f203
commit 4b34cf1ffb
2 changed files with 10 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -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 <appname> --target=<url> --platform=<platform> --arch=<arch> --version=<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
@ -75,3 +78,4 @@ $ nativefier Messenger --platform=darwin --arch=x64 --version=0.29.1 --target='h
- Set the app icon from a url in the CLI
- Set the app window dimensions from the CLI
- Dock badges

2
usage.txt
View File

@ -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