diff --git a/README.md b/README.md index 30408b46..04b0bac6 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,68 @@ -# Official TinyMCE React component +# Official TinyMCE React Component ## About -This package is a thin wrapper around [TinyMCE](https://github.com/tinymce/tinymce) to make it easier to use in a React application. + Official React component for TinyMCE, the rich text editor. It makes integrating TinyMCE into React applications easy and seamless. -* If you need detailed documentation on TinyMCE, see: [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/8/). -* For the TinyMCE React Quick Start, see: [TinyMCE Documentation - React Integration](https://www.tiny.cloud/docs/tinymce/8/react-cloud/). -* For the TinyMCE React Technical Reference, see: [TinyMCE Documentation - TinyMCE React Technical Reference](https://www.tiny.cloud/docs/tinymce/8/react-ref/). -* For our quick demos, check out the TinyMCE React [Storybook](https://tinymce.github.io/tinymce-react/). +## Quickstart +### Cloud CDN -### Issues +In your React project: -Have you found an issue with tinymce-react or do you have a feature request? Open up an [issue](https://github.com/tinymce/tinymce-react/issues) and let us know or submit a [pull request](https://github.com/tinymce/tinymce-react/pulls). *Note: For issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce).* \ No newline at end of file +1. [Sign up for a Tiny Cloud account](https://www.tiny.cloud/pricing/) to receive a Tiny Cloud API key. +2. `npm install @tinymce/tinymce-react` +3. Include the following code: + +```js +import React from 'react'; +import { Editor } from '@tinymce/tinymce-react'; + +export default function App() { + return ( + <> +

TinyMCE React demo

+ + + ); +} +``` + +4. Update the `apiKey` prop on the `Editor` component to include your Tiny Cloud API key. + +For more information: [Using TinyMCE with React - Cloud CDN](https://www.tiny.cloud/docs/tinymce/latest/react-cloud/) + +### Self hosted via NPM package + +Using TinyMCE from NPM in a React project requires a couple of extra steps. See the documentation for more information: [Using TinyMCE with React - Self hosted via NPM](https://www.tiny.cloud/docs/tinymce/latest/react-pm/) + + +## Demos + +For our quick demos, check out the TinyMCE React [Storybook](https://tinymce.github.io/tinymce-react/). + +## Detailed documentation + +* [TinyMCE React Technical Reference](https://www.tiny.cloud/docs/tinymce/latest/react-ref/). +* [TinyMCE Documentation](https://www.tiny.cloud/docs/tinymce/latest/). + + +## Issues + +Have you found an issue with `tinymce-react` or do you have a feature request? +Open up an [issue](https://github.com/tinymce/tinymce-react/issues) and let us know +or submit a [pull request](https://github.com/tinymce/tinymce-react/pulls). + +_Note: for issues concerning TinyMCE please visit the [TinyMCE repository](https://github.com/tinymce/tinymce)._ + + +## License + +`tinymce-react` is licensed under the MIT License. See the LICENSE.txt file for details. + +Depending on use case, the TinyMCE core editor can be used under either GPL-2.0-or-later or a commercial license. See the [tinymce package](https://www.npmjs.com/package/tinymce) for details. diff --git a/contributing.md b/contributing.md index b561e52d..c970dad8 100644 --- a/contributing.md +++ b/contributing.md @@ -1,8 +1,5 @@ # Contributing -This project follows the [beehive-flow](https://github.com/tinymce/beehive-flow/) branching process ("Basic process - release from main branch"). -Please read the [beehive-flow readme](https://github.com/tinymce/beehive-flow/blob/main/README.md) for more information. -This mainly affects branching and merging for Tiny staff. +External contributors are free to submit PRs against the `main` branch. -External contributors are free to submit PRs against the `main` branch. -Note that contributions will require signing of our Contributor License Agreement. +In order for Tiny to accept your contribution, we will need legal permission from you to use your code. Please email `legal@tiny.cloud` with the subject `CLA request for [your Github username]`. Our legal team will send you a Contributors License Agreement (CLA) which you will need to sign and return. diff --git a/package.json b/package.json index b627bd6e..6f493a3a 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "description": "Official TinyMCE React Component", + "description": "Official React component for TinyMCE, a rich text editor.", "repository": { "url": "https://github.com/tinymce/tinymce-react" }, @@ -22,7 +22,16 @@ "build-storybook": "storybook build", "deploy-storybook": "storybook build && gh-pages -d ./storybook-static -u 'tiny-bot ' --nojekyll" }, - "keywords": [], + "keywords": [ + "tinymce", + "react", + "component", + "editor", + "wysiwyg", + "rich-text-editor", + "html", + "contenteditable" + ], "author": "Ephox Corporation DBA Tiny Technologies, Inc.", "license": "MIT", "dependencies": {