Skip to content

Commit 0112af0

Browse files
committed
Remove docs from README.md
1 parent 500e294 commit 0112af0

File tree

1 file changed

+0
-44
lines changed

1 file changed

+0
-44
lines changed

README.md

Lines changed: 0 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -3,47 +3,3 @@
33
This package is a thin wrapper around [HugeRTE](https://github.com/hugerte/hugerte) to make it easier to use in a React application.
44

55
Documentation for this package is available at the [HugeRTE React Integration docs page](https://github.com/hugerte/hugerte-docs/blob/main/integrations/react.md).
6-
7-
TODO: this will get into docs
8-
9-
# HugeRTE React integration
10-
This file provides documentation for the [HugeRTE React integration package](https://github.com/hugerte/hugerte-react).
11-
12-
## Storybook
13-
The repo linked above comes with a storybook showing examples of integrating HugeRTE with React. To run the storybook, follow the following steps:
14-
1. Clone the repo:
15-
```bash
16-
git clone https://github.com/hugerte/hugerte-react
17-
```
18-
2. Install dependencies:
19-
```bash
20-
yarn
21-
```
22-
3. Run the storybook:
23-
```bash
24-
yarn storybook
25-
```
26-
27-
[View the source code of the Storybook examples.](https://github.com/hugerte/hugerte-react/blob/main/src/stories/Editor.stories.tsx).
28-
29-
## Get started with integrating HugeRTE into your React project
30-
Add the HugeRTE React component to your project using npm (or an npm-based package manager like yarn):
31-
32-
```bash
33-
npm install @hugerte/hugerte-react
34-
```
35-
36-
or:
37-
38-
```bash
39-
yarn add @hugerte/hugerte-react
40-
```
41-
42-
Then, you could copy an appropiate demo piece from the storybook file linked above into your project. **While the storybook file contains `import { Editor, IAllProps } from '../main/ts/components/Editor';`, you should import from `@hugerte/hugerte-react` instead.** If your code will contain non-trivial portions of demo code, add the text of the [LICENSE.txt](LICENSE.txt) file as a comment to your code or on some „Acknowledgements“ page to ensure legal compliance.
43-
44-
## TinyMCE React integration docs
45-
Instead of looking at the Storybook and copying code from there, you can also [visit this link which will redirect you to the TinyMCE docs for now which provide detailed reference](https://hugerte.org/docs/hugerte/1/react-ref). But, **note that we have changed some props**: Please view the [changelog](CHANGELOG.md).
46-
47-
## Issues
48-
49-
Have you found an issue with `hugerte-react` or do you have a feature request? Open up an [issue](https://github.com/hugerte/hugerte-react/issues) and let us know or submit a [pull request](https://github.com/hugerte/hugerte-react/pulls). *Note: for issues related to HugeRTE itself please visit the [HugeRTE repository](https://github.com/hugerte/hugerte).*

0 commit comments

Comments
 (0)