update meta

CHANGELOG.md

@@ -1,5 +1,57 @@
 ### Changelog
 
+#### 4.0.0
+
+iro.js version 4.0.0 is a major rewrite of the core library which aims to solve numerous long-standing issues. There are numerous changes and deprecations, so please check the [migration guide](https://iro.js.org/migrating.html) before moving your project over. If needed, version 3.5.1 has been preserved in the [v3 branch](https://github.com/jaames/iro.js/tree/v3).
+
+##### Additions
+
+* Custom SVG handles
+* Custom layout config options
+* Plugin API
+* Code tests
+* Rewritten codebase, is now *much* cleaner
+* Color picker components are now built using [preact](https://preactjs.com/)
+* Rewritten documentaion and readme, which huge focus on making things easier to follow
+
+##### Breaking Changes
+
+**Color Picker**
+
+* `anticlockwise` option has been removed, and is now hardcoded to `true`
+* `markerRadius` option has been renamed as `handleRadius`
+
+**Safari Bugfix Note**
+
+To resolve an issue where Safari wasn't rendering the color picker properly because of certain client-side routing libraries, it was previously recommended to call `emit('history:statechange')` on the color picker when navigating to new client-side routes. This has been deprecated in favour of the catch-all `forceUpdate()` color picker method.
+
+**Static Color Methods**
+
+* `hsv2Hsl` renamed to `hsvToHsl`
+* `hsl2Hsv` renamed to `hslToHsv`
+* `rgb2Hsv` renamed to `rgbToHsv`
+* `hsv2Rgb` renamed to `hsvToRgb`
+* `parseHexStr` removed
+* `parseRgbStr` removed
+* `parseHslStr` removed
+* `rgb2Hex` removed
+* `rgb2Str` removed
+* `hsl2Str` removed
+* `mix` removed
+* `lighten` removed
+* `darken` removed
+* `compare` removed
+
+**Color Methods**
+
+* `mix` removed
+* `lighten` removed
+* `darken` removed
+
+**Stylesheet API**
+
+* The Dynamic CSS feature and has become a seperate plugin; [iro-dynamic-css](https://github.com/jaames/iro-dynamic-css).
+
 #### 3.5.1
 
 ##### Additions

CONTRIBUTING.md

@@ -12,6 +12,12 @@ $ npm install
 $ npm start
 ```
 
+### Run tests
+
+```bash
+$ npm test
+```
+
 ### Produce final build
 
 ```bash

README.md

@@ -1,4 +1,4 @@
-> :warning: This readme is for the beta release of iro.js v4. Some parts are currently incomplete or lacking detail. Please read [this issue thread](https://github.com/jaames/iro.js/issues/30) for more info!
+> :warning: This readme is for iro.js v4, which is a major rewrite of the library. If you are still using v3 (version 3.5.1 and below) please read the [migration guide](https://iro.js/org/migrating.html). The v3 version of the library and documentation is preserved in the [v3 branch](https://github.com/jaames/iro.js/tree/v3) if you need it!
 
 <h1 align="center"><a href="//iro.js.org"><img height="340" src="https://raw.githubusercontent.com/jaames/iro.js/v4/assets/screenshot.png"/><br/>iro.js</a></h1>
 

deploy.sh

@@ -14,7 +14,7 @@ echo 'iro.js.org' > CNAME
 
 git init
 git add -A
-git commit -m 'deploy'
+git commit -m 'deploy iro.js.org'
 
 # if you are deploying to https://<USERNAME>.github.io/<REPO>
 git push -f [email protected]:jaames/iro.js.git master:gh-pages

docs/migrating.md

@@ -4,11 +4,17 @@ title: Migration Guide
 
 ## Migrating from v3
 
+iro.js version 4.0.0 is a major rewrite of the core library which aims to solve numerous long-standing issues with the library. Most of these changes won't affect 99% of the core use-cases, but if needed, version 3.5.1 has been preserved in the [v3 branch](https://github.com/jaames/iro.js/tree/v3).
+
 ### Color Picker Options
 
 * `anticlockwise` option has been removed, and is now hardcoded to `true`
 * `markerRadius` option has been renamed as `handleRadius`
 
+### Safari Bugfix Note
+
+To resolve an issue where Safari wasn't rendering the color picker properly because of certain client-side routing libraries, it was previously recommended to call `emit('history:statechange')` on the color picker when navigating to new client-side routes. This has been deprecated in favour of the catch-all `forceUpdate()` color picker method.
+
 ### Static Color Methods
 
 The following methods have been renamed:
@@ -33,7 +39,7 @@ The following methods have been removed:
 
 ### Color Methods
 
-The following
+The following color methods have been removed:
 
 * `mix`
 * `lighten`