From b2f4750eede2da05a64375a60199a48061005dbf Mon Sep 17 00:00:00 2001 From: Ian Storm Taylor Date: Tue, 28 Jun 2016 09:27:00 -0700 Subject: [PATCH] update readme --- Readme.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index ed25ee8cd..88103591b 100644 --- a/Readme.md +++ b/Readme.md @@ -4,6 +4,8 @@ Slate is a completely customizable framework for building rich text editors in the browser. You can think of it like a pluggable implementation of `contenteditable`, built with React and Immutable. Slate was inspired by [Draft.js](https://facebook.github.io/draft-js/) and [Prosemirror](http://prosemirror.net/). +_Slate is currently in **beta**, while work is being done on: cross-browser support, atomic node support, and collaboration support. It's completely useable, but you might need to pull request one or two fixes for your use case._ + ###### Table of Contents - [Principles](#principles) @@ -18,12 +20,16 @@ Slate is a completely customizable framework for building rich text editors in t - Doesn't bake any opinions about the schema being edited into the core library. - Designed to allow for collaborative editing to be layered on top. + ## Examples -To get a sense for how Slate works, check out a few of the examples: +To get a sense for how you might use Slate, check out a few of the examples: - Rich Text - Plain Text - Auto-markdown - Links - Tables + + +## Getting Started