README updated with info about changes in v3 #28
Conversation
README.md
Outdated
| @@ -74,7 +80,7 @@ import chromatism from 'chromatism'; | |||
| ## Functions | |||
| All functions can take any colour type. **You can even mix colour types** if a function takes more than one. [A list of colour types are available here](#colour-modes). Return values are also not bound by the function. Any functions that return colours, return a colour object, which contains getters for each colour type. If you take the return value of one of these functions and get `returnValue.hex` for example, you will get the hexadecimal equivalent value. | |||
|
|
|||
| You can also chain these functions. The last parameter will be piped in from the output of the parent function. | |||
| In previous versions (Pre. v2.6), you could chain functions. This functionality has been removed to save space on the bundle. | |||
There was a problem hiding this comment.
Instead of (Pre. v2.6) it might be better to just say (2.x) - there's nothing stopping us from going back and pushing patch versions of version 2, and the semver syntax seems a bit clearer anyway.
|
What's that about a browser-compatible copy? The refactor branch is already set to publish ES5-compatible UMD and CJS bundles as well as the stock ESM version. The other readme changes look fine to me! |
|
@TehShrike should include /dist with pre-built versions, so it can be just installed + included into a document, seems weird to have to run a build script in a directory in your node_modules folder just to include a UMD module, could also add a post-install script |
|
This all looks good to me! We should continue the discussion about the current distribution build setup in the chat room, feel free to merge this and we can move towards publishing. |
Will need to discuss including a browser-compatible copy as well. Let that under the installation methods heading