Skip to content

Commit

Permalink
Merge pull request #107 from LinusU/docs/hidden-files
Browse files Browse the repository at this point in the history
Docs/hidden files
  • Loading branch information
cstruct committed May 22, 2016
2 parents 43cf161 + 6da1026 commit 67fa3f8
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ the JSON file's path.
+ `icon` (string, optional) - Path to your icon, which will be shown when mounted
+ `background` (string, optional) - Path to your background
+ `background-color` (string, optional) - Background color (accepts css colors)
+ `icon-size` (string, optional) - Size of all the icons inside the DMG
+ `icon-size` (number, optional) - Size of all the icons inside the DMG
+ `window` (object, optional) - Window options
+ `position` (object, optional) - Position when opened
+ `x` (number, required) - X position relative to bottom of the screen
Expand Down Expand Up @@ -141,6 +141,19 @@ Currently the only supported os is Mac OS X.

Track the status of this here: https://github.com/LinusU/node-appdmg/issues/14

## Hidden files

By default hidden files will show for users with `com.apple.finder AppleShowAllFiles`
set to `TRUE`. This can be worked around by moving all hidden files outside the initial
window size, this has the side-effect of enabling a scrollbar.

Files to usually move:

- `.background`
- `.DS_Store`
- `.Trashes`
- `.VolumeIcon.icns`

## Alternatives

* [create-dmg](https://github.com/andreyvit/create-dmg/blob/master/README.md), a Bash script
Expand Down

0 comments on commit 67fa3f8

Please sign in to comment.