From f00d6dcfd390f6ad4e08f5df383b56db6240d767 Mon Sep 17 00:00:00 2001 From: "Patrick Senti (shrebo)" Date: Sun, 17 Apr 2016 10:58:45 +0200 Subject: [PATCH] update documentation --- CHANGELOG.md | 7 +++++++ README.md | 13 +++++++++++++ 2 files changed, 20 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f2b41f..ff16e7a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 files (not backwards compatible) +- Add --help option +- Ability to specify output path +- Backwards-compatibility mode to use platforms path instead of new defaults (-c) + ## [0.5.1] - 2016-03-11 - iOS: Get back sizes from previous version of the repo (eb65d2d) diff --git a/README.md b/README.md index d6872ff..c79ca43 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,19 @@ Automatic splash screen generator for Cordova. Create a splash screen (2208x2208 Create a `splash.png` file in the root folder of your cordova project and run: $ cordova-splash + +You may specify the output path and directory as follows: + + # output to path/to/res/screen + $ cordova-splash -p path/to/res -s screen + +WARNING: If you were using a previous version of cordova-splash and expect the generated files to be in their respective ./platforms +path, use the compability mode: + + $ cordova-splash -c + +This will override the -p and -s settings. + ### Icons