diff --git a/History.md b/History.md index c4ff6049a..a7ae7ffac 100644 --- a/History.md +++ b/History.md @@ -5,6 +5,20 @@ This document maintains a list of changes to Slate with each new version. Until --- +### `0.14.0` (next) — September 10, 2016 + +###### BREAKING CHANGES + +- **The `undo` and `redo` transforms need to be applied!** Previously, `undo` and `redo` were special cased such that they did not require an `.apply()` call, and instead would return a new `State` directly. Now this is no longer the case, and they are just like every other transform. + +- **Transforms are no longer exposed on `State` or `Node`.** The transforms API has been completely refactored to be built up of "operations" for collaborative editing support. As part of this refactor, the transforms are now only available via the `state.transform()` API, and aren't exposed on the `State` or `Node` objects as they were before. + +- **The selection can now be "unset".** Previously, a selection could never be in an "unset" state where the `anchorKey` or `focusKey` was null. This is no longer technically true, although this shouldn't really affect anyone in practice. + + +--- + + ### `0.13.0` — August 15, 2016 ###### BREAKING CHANGES diff --git a/lib/Readme.md b/lib/Readme.md index dc92ff393..c26576908 100644 --- a/lib/Readme.md +++ b/lib/Readme.md @@ -2,9 +2,11 @@ This directory contains the core logic of Slate. It's separated further into a series of directories: - [**Components**](./components) — containing the React components Slate renders. +- [**Constants**](./constants) — containing constants that are used in Slate's codebase. - [**Models**](./models) — containing the models that define Slate's internal data structure. - [**Plugins**](./plugins) — containing the plugins that ship with Slate by default. - [**Serializers**](./serializers) — containing the serializers that ship with Slate by default. +- [**Transforms**](./transforms) — containing the transforms that are used to alter a Slate document. - [**Utils**](./utils) — containing a few private convenience modules. Feel free to poke around in each of them to learn more! diff --git a/lib/constants/Readme.md b/lib/constants/Readme.md new file mode 100644 index 000000000..226ed69dd --- /dev/null +++ b/lib/constants/Readme.md @@ -0,0 +1,2 @@ + +This directory contains constants that are referenced elsewhere in Slate's codebase. They are kept here for consistency. diff --git a/lib/transforms/Readme.md b/lib/transforms/Readme.md new file mode 100644 index 000000000..88a14e399 --- /dev/null +++ b/lib/transforms/Readme.md @@ -0,0 +1,2 @@ + +This directory contains all of the transforms that ship with Slate by default. For example, transforms like `insertText` or `addMarkAtRange`.