Skip to content
This repository has been archived by the owner on Oct 19, 2020. It is now read-only.

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
miraculixx committed Apr 17, 2016
1 parent 2771dc1 commit 126a8c3
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
All notable changes to this project [will be documented](http://keepachangelog.com/) in this file.
This project *tries to* adhere to [Semantic Versioning](http://semver.org/).

## [0.7.0] - 2016-14-17

- uses config/res as the default folder to persist generated icons (not backwards compatible)
- Add --help option
- Ability to specify output path
- Backwards-compatibility mode to use platforms path instead of new defaults (-c)

## [0.6.0] - 2016-03-08
- Allow platform-specific icons (0c26dfe)

Expand Down
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,25 @@ Then run:

$ cordova-icon

You may specify the output path and directory as follows:

# output to path/to/res/icon
$ cordova-splash -p path/to/res icon
WARNING: If you were using a previous version of cordova-icon and expect the generated files to be in their respective ./platforms
path, use the compability mode:

$ cordova-icon -c

This will override the -p and -i settings.

For good results, your file shoud be:

- square
- for Android and iOS, at least 192\*192px (512\*512px recommended to be future-proof)
- for Windows, at least 1240\*1240px


### Creating a cordova-cli hook

Since the execution of cordova-icon is pretty fast, you can add it as a cordova-cli hook to execute before every build.
Expand Down

0 comments on commit 126a8c3

Please sign in to comment.