diff --git a/README.md b/README.md index da634220..c9b869c4 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,14 @@ A renderless and extendable rich-text editor for [Vue.js](https://github.com/vue ## Why I built tiptap I was looking for a text editor for [Vue.js](https://github.com/vuejs/vue) and found some solutions that didn't really satisfy me. The editor should be easy to extend and not based on old dependencies such as jQuery. For React there is already a great editor called [Slate.js](https://github.com/ianstormtaylor/slate), which impresses with its modularity. I came across [Prosemirror](https://github.com/prosemirror) and decided to build on it. Prosemirror is a toolkit for building rich-text editors that is already in use at many well-known companies such as *Atlassian* or *New York Times*. +### What means `renderless`? + +Will renderless components you'll have (almost) full control over markup and styling. I don't want to tell you what a menu should look like or where it should be rendered in the DOM. That's all up to you. There is also a [good article](https://adamwathan.me/renderless-components-in-vuejs/) about renderless components by Adam Wathan. + +### How is the data stored under the hood? + +You can save your data as a raw `HTML` string or can get a `JSON`-serializeable representation of your document. And of course you can pass these two types back to the editor. + ## Examples To check out some live examples, visit [tiptap.scrumpy.io](https://tiptap.scrumpy.io/).