Skip to content

Commit

Permalink
docs: updated blurb
Browse files Browse the repository at this point in the history
  • Loading branch information
ifiokjr committed Jul 17, 2019
1 parent 098e942 commit 37b7c9c
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 5 deletions.
18 changes: 16 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,23 @@ route: /
- [Installation](https://docs.remirror.org/install)
- [Walkthrough guide](https://docs.remirror.org/walkthrough)

## Getting Started
## Features

- Full support for **Server Side Rendering (SSR)** with **zero config**.
- **Top quality** prebuilt editors for immediate use in your next application.
- Almost 30 ready-made extensions for adding your own flavour and functionality to build your dream editor.
- CSS-in-JS support (can be switched off).

**_Coming soon_**

⚠️**Warning**: This is still a prerelease library. The docs are poor and the API is subject to change. Over the next few months the quality will be bumped up and the use cases will grow.
- [ ] React Native support
- [ ] Tables support via an extension
- [ ] Iframe support
- [ ] Markdown editor
- [ ] Multicursor editing via an extension
- [ ] CSS class support

## Getting Started

For now to learn and understand, the best way is via looking through the `@remirror/editor-*` libraries.

Expand Down
20 changes: 17 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,23 @@

<br />

## Getting Started
## Features

- Full support for **Server Side Rendering (SSR)** with **zero config**.
- **Top quality** prebuilt editors for immediate use in your next application.
- Almost 30 ready-made extensions for adding your own flavour and functionality to build your dream editor.
- CSS-in-JS support (can be switched off).

**_Coming soon_**

⚠️**Warning**: This is still a work in progress library. The docs are being worked on and the API is still subject to breaking changes for minor releases. For now to learn and understand, the best way is via looking through the `@remirror/editor-*` libraries.
- [ ] React Native support
- [ ] Tables support via an extension
- [ ] Iframe support
- [ ] Markdown editor
- [ ] Multicursor editing via an extension
- [ ] CSS class support

## Getting Started

### Prerequisites

Expand All @@ -45,7 +59,7 @@
yarn add @remirror/core @remirror/react @remirror/core-extensions
```

The following is a small example which renders a floating menu and enables the extensions `Bold`, `Italic` and `Underline`.
The following is an example editor which renders a floating menu and enables the extensions `Bold`, `Italic` and `Underline`.

```ts
import React, { FC, FunctionComponent, MouseEventHandler, useState } from 'react';
Expand Down

0 comments on commit 37b7c9c

Please sign in to comment.