English | [简体中文](README.zh-CN.md)

<h1 align="center">Fantasy Editor</h1>

<div align="center">

A Rich Text Editor Based On [Slate](https://github.com/ianstormtaylor/slate) and [React](https://github.com/facebook/react).

[![GitHub](https://img.shields.io/github/license/lingjieee/fantasy-editor)](LICENSE)
[![npm](https://img.shields.io/npm/v/fantasy-editor)](https://www.npmjs.com/package/fantasy-editor)
[![npm](https://img.shields.io/npm/dm/fantasy-editor)](https://www.npmjs.com/package/fantasy-editor)

</div>

## Installation

### npm

```bash | pure
npm install fantasy-editor --save
```

## Examples

```bash | pure
# Clone the repository
$ git clone https://github.com/lingjieee/fantasy-editor.git

# Change directory
$ cd fantasy-editor

# Install dependencies
$ yarn install

# Run examples
$ yarn start
```