From fa70fc5d98405f9fc2c5b524fde8312d5c9fb91e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20K=C3=BChn?= Date: Thu, 23 Aug 2018 08:33:21 +0200 Subject: [PATCH] update readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 77c0273a..558bc979 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,20 @@ export default { ``` +## Editor Properties + +| Property | Type | Default | Description | +| - | :-: | :-: | - | +| editable | Boolean | `true` | When set to `false` the editor is read-only. | +| doc | Object | `null` | The editor state object used by Prosemirror. You can also pass HTML to the `content` slot. When used both, the `content` slot will be ignored. | +| extensions | Array | `[]` | A list of extensions used, by the editor. This can be `Nodes`, `Marks` or `Plugins`. | +| @update | Function | `undefined` | This will return the current `state` of Prosemirror on every change. | + +## Extensions + +Soon … +Until then you can take a look at the [embed example](https://github.com/heyscrumpy/tiptap/tree/master/examples/Components/Routes/Embeds). + ## Contributing Please see [CONTRIBUTING](CONTRIBUTING.md) for details.