diff --git a/CHANGELOG.md b/CHANGELOG.md index bcb5fe91..32cec049 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -# CKEditor 4 React Integration Changelog +# CKEditor 4 WYSIWYG Editor React Integration Changelog ## ckeditor4-react 1.0.0 @@ -8,40 +8,40 @@ New Features: Fixed Issues: -* [#46](https://github.com/ckeditor/ckeditor4-react/issues/46): Fixed: Integration tries to destroy non-existent editor instance in some cases. Thanks to [Oleg Kachmar](https://github.com/prokach)! -* [#44](https://github.com/ckeditor/ckeditor4-react/issues/44): Fixed: Error thrown when quickly changing routes. -* [#49](https://github.com/ckeditor/ckeditor4-react/issues/49): Fixed: The "Cannot read property 'getEditor' of null" error thrown when component is unmounted. -* [#56](https://github.com/ckeditor/ckeditor4-react/issues/56): Fixed: CKEditor crashes when unmounting with "Cannot read property 'destroy' of null" error. +* [#46](https://github.com/ckeditor/ckeditor4-react/issues/46): Fixed: Integration tries to destroy a non-existent editor instance in some cases. Thanks to [Oleg Kachmar](https://github.com/prokach)! +* [#44](https://github.com/ckeditor/ckeditor4-react/issues/44): Fixed: An error thrown when changing routes quickly. +* [#49](https://github.com/ckeditor/ckeditor4-react/issues/49): Fixed: A "Cannot read property 'getEditor' of null" error thrown when the component is unmounted. +* [#56](https://github.com/ckeditor/ckeditor4-react/issues/56): Fixed: CKEditor crashes when unmounting with a "Cannot read property 'destroy' of null" error. Other Changes: -* Updated default CDN CKEditor 4 dependency to [`4.13.0`](https://github.com/ckeditor/ckeditor4-react/commit/7b34d2c4f896ced08e66359faca28194ed7e8ef4). +* Updated the default CKEditor 4 CDN dependency to [`4.13.0`](https://github.com/ckeditor/ckeditor4-react/commit/7b34d2c4f896ced08e66359faca28194ed7e8ef4). ## ckeditor4-react 1.0.0-beta.2 New Features: -* [#47](https://github.com/ckeditor/ckeditor4-react/issues/47): Exposed `CKEDITOR` namespace before loading editor instance. Thanks to [Nick Rattermann](https://github.com/nratter)! +* [#47](https://github.com/ckeditor/ckeditor4-react/issues/47): Exposed the `CKEDITOR` namespace before loading the editor instance. Thanks to [Nick Rattermann](https://github.com/nratter)! * [#48](https://github.com/ckeditor/ckeditor4-react/pull/48): Added `CKEDITOR.displayName` for easy debugging and testing. Thanks to [Florent Berthelot](https://github.com/FBerthelot)! Other Changes: -* Updated default CDN CKEditor 4 dependency to [`4.12.1`](https://github.com/ckeditor/ckeditor4-react/commit/e72c2fb2d8e107419fe209c436c909915237a109). +* Updated the default CKEditor 4 CDN dependency to [`4.12.1`](https://github.com/ckeditor/ckeditor4-react/commit/e72c2fb2d8e107419fe209c436c909915237a109). ## ckeditor4-react 1.0.0-beta Other Changes: -* Updated `LICENSE.md` file with all development and production dependencies. +* Updated the `LICENSE.md` file with all development and production dependencies. ## ckeditor4-react 0.1.1 Other Changes: -* Updated all CKEditor 4 dependencies to `4.11.4` version. +* Updated all CKEditor 4 dependencies to the `4.11.4` version. * `README.md` file improvements. ## ckeditor4-react 0.1.0 -The first beta release of CKEditor 4 React Integration. +The first beta release of the CKEditor 4 WYSIWYG Editor React Integration. diff --git a/LICENSE.md b/LICENSE.md index b0c6f18e..2c270d9f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,7 +1,7 @@ Software License Agreement ========================== -**CKEditor 4 component for React** – https://github.com/ckeditor/ckeditor4-react
+**CKEditor 4 WYSIWYG editor component for React** – https://github.com/ckeditor/ckeditor4-react
Copyright (c) 2003-2019, [CKSource](http://cksource.com) Frederico Knabben. All rights reserved. Licensed under the terms of any of the following licenses at your @@ -21,7 +21,7 @@ Sources of Intellectual Property Included in CKEditor Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission. -The following libraries are included in CKEditor 4 component for React under the [MIT license](https://opensource.org/licenses/MIT): +The following libraries are included in CKEditor 4 WYSIWYG editor component for React under the [MIT license](https://opensource.org/licenses/MIT): - load-script - prop-types (c) 2013-present, Facebook, Inc. diff --git a/README.md b/README.md index 18c0aea5..188a256b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# CKEditor 4 rich text editor component for React [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20React%20integration&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fckeditor4-react) +# CKEditor 4 WYSIWYG editor component for React [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20React%20integration&url=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2Fckeditor4-react) [![npm version](https://badge.fury.io/js/ckeditor4-react.svg)](https://www.npmjs.com/package/ckeditor4-react) [![GitHub tag](https://img.shields.io/github/tag/ckeditor/ckeditor4-react.svg)](https://github.com/ckeditor/ckeditor4-react) @@ -10,7 +10,7 @@ [![Join newsletter](https://img.shields.io/badge/join-newsletter-00cc99.svg)](http://eepurl.com/c3zRPr) [![Follow Twitter](https://img.shields.io/badge/follow-twitter-00cc99.svg)](https://twitter.com/ckeditor) -Official [CKEditor 4](https://ckeditor.com/ckeditor-4/) rich text editor component for React. +Official [CKEditor 4](https://ckeditor.com/ckeditor-4/) WYSIWYG editor component for React. We are looking forward to your feedback! You can report any issues, ideas or feature requests on the [integration issues page](https://github.com/ckeditor/ckeditor4-react/issues/new). @@ -21,36 +21,36 @@ We are looking forward to your feedback! You can report any issues, ideas or fea ```jsx import CKEditor from 'ckeditor4-react'; - + ``` ## Documentation and examples -See the [React Integration](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_react.html) article in the [CKEditor 4 documentation](https://ckeditor.com/docs/ckeditor4/latest). +See the [CKEditor 4 WYSIWYG Editor React Integration](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_react.html) article in the [CKEditor 4 documentation](https://ckeditor.com/docs/ckeditor4/latest). -You can also check out [React example](https://ckeditor.com/docs/ckeditor4/latest/examples/react.html) in the [CKEditor 4 Example](https://ckeditor.com/docs/ckeditor4/latest/examples/). +You can also check out [CKEditor 4 WYSIWYG Editor React Integration example](https://ckeditor.com/docs/ckeditor4/latest/examples/react.html) in [CKEditor 4 Examples](https://ckeditor.com/docs/ckeditor4/latest/examples/). ## Contributing After cloning this repository, install necessary dependencies: -```bash +``` npm install ``` ### Executing tests -```bash +``` npm run test ``` -If you are going to change the source files (ones located in `src/` directory), remember about rebuilding the package. You can use `npm run develop` in order to do it automatically. +If you are going to change the source files (ones located in the `src/` directory), remember about rebuilding the package. You can use `npm run develop` in order to do it automatically. ### Building the package Build a minified version of the package that is ready to publish: -```bash +``` npm run build ``` diff --git a/scripts/bump.js b/scripts/bump.js index 98d9b2f5..b38d05ff 100644 --- a/scripts/bump.js +++ b/scripts/bump.js @@ -14,17 +14,17 @@ if ( !( args && args[ 2 ] && args[ 2 ].length > 2 ) ) { const version = args[ 2 ]; -// Update CDN link in 'src/ckeditor.jsx' file. +// Update the CDN link in the 'src/ckeditor.jsx' file. updateCdnLink( path.resolve( __dirname, '..', 'src', 'ckeditor.jsx' ) ); -// Update CDN link in 'karma.conf.js' file. +// Update the CDN link in the 'karma.conf.js' file. updateCdnLink( path.resolve( __dirname, '..', 'karma.conf.js' ) ); // Update 'peerDependency' in 'package.json'. pkg.peerDependencies.ckeditor4 = `^${ version }`; fs.writeFileSync( path.resolve( __dirname, '..', 'package.json' ), JSON.stringify( pkg, null, ' ' ) ); -// Update 'devDependency' in 'package.json' file and entire 'package-lock.json' file. +// Update 'devDependency' in the 'package.json' file and the entire 'package-lock.json' file. shell.exec( `npm install ckeditor4@${ version } --save-dev` ); function updateCdnLink( path ) { diff --git a/webpack.config.js b/webpack.config.js index f970a198..520ef90f 100644 --- a/webpack.config.js +++ b/webpack.config.js @@ -63,7 +63,7 @@ module.exports = { plugins: [ new webpack.BannerPlugin( { banner: `/*!* - * @license Copyright (c) 2003-2018, CKSource - Frederico Knabben. All rights reserved. + * @license Copyright (c) 2003-2019, CKSource - Frederico Knabben. All rights reserved. * For licensing, see LICENSE.md. */`, raw: true