From f65a033b68a99dc8bbf5a8caf92021bd27e19585 Mon Sep 17 00:00:00 2001 From: Jakub Pawlowicz Date: Mon, 19 Dec 2016 08:11:29 +0100 Subject: [PATCH] Adds Readme section on 4.0 breaking changes. --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 085b19dd..3dd13791 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,16 @@ According to [tests](http://goalsmashers.github.io/css-minification-benchmark/) ## Usage -### This documentation refers to a pre-release version of clean-css. See [3.4 branch](https://github.com/jakubpawlowicz/clean-css/tree/3.4) for the current release docs. +### This documentation refers to a pre-release version of clean-css 4.0. See [3.4 branch](https://github.com/jakubpawlowicz/clean-css/tree/3.4) for the current release docs. + +### What will change in clean-css 4? + +There will be some breaking changes: + +* `root`, `relativeTo`, and `target` options are replaced by a single `rebaseTo` option - this means that rebasing URLs and import inlining is much simpler but may not be (YMMV) as powerful as in 3.x. +* `debug` API option is gone as stats are always provided in output object under `stats` property + +Please note this list is not final. You are more than welcome to comment these changes in [4.0 release discussion](https://github.com/jakubpawlowicz/clean-css/issues/842) thread. ### What are the requirements? -- 2.34.1