From 63f36b4c69664784a24e229bbc60e074efc0e24c Mon Sep 17 00:00:00 2001 From: Sibiraj Date: Tue, 10 Apr 2018 17:17:26 +0530 Subject: [PATCH] docs: update README with peerDependencies closes #92 --- README.md | 10 ++ .../additional-documentation/code-editor.html | 16 +-- docs/additional-documentation/colors.html | 16 +-- .../configuration.html | 16 +-- docs/additional-documentation/errors.html | 16 +-- docs/additional-documentation/font-size.html | 16 +-- .../image-uploader.html | 16 +-- .../insert-video.html | 16 +-- .../prerequisites.html | 18 +-- docs/additional-documentation/resizer.html | 16 +-- docs/additional-documentation/toolbar.html | 16 +-- docs/components/NgxEditorComponent.html | 16 +-- .../components/NgxEditorMessageComponent.html | 16 +-- .../components/NgxEditorToolbarComponent.html | 16 +-- docs/components/NgxGrippieComponent.html | 16 +-- docs/dependencies.html | 16 +-- docs/graph/dependencies.svg | 120 ++++++++++------ docs/index.html | 24 ++-- docs/injectables/CommandExecutorService.html | 16 +-- docs/injectables/MessageService.html | 16 +-- docs/js/search/search_index.js | 4 +- docs/license.html | 16 +-- docs/miscellaneous/functions.html | 16 +-- docs/miscellaneous/variables.html | 16 +-- docs/modules.html | 16 +-- docs/modules/NgxEditorModule.html | 136 +++++++++++------- docs/modules/NgxEditorModule/dependencies.svg | 120 ++++++++++------ docs/overview.html | 136 +++++++++++------- extras/docs/prerequisites.md | 2 +- 29 files changed, 506 insertions(+), 384 deletions(-) diff --git a/README.md b/README.md index 4e32178e..0493e770 100644 --- a/README.md +++ b/README.md @@ -55,8 +55,18 @@ Then in HTML For `ngModel` to work, You must import `FormsModule` from `@angular/forms` +#### PeerDependencies + +`ngx-editor` depeneds on the following libraries to work. + +* [Font-Awesome v4.7.0](https://github.com/FortAwesome/Font-Awesome/tree/fa-4) +* [CodeMirror](https://github.com/codemirror/codemirror) +* [Ngx-Bootstrap](https://github.com/valor-software/ngx-bootstrap) + ## Compatibility +All Evergreen-Browsers are supported + * Google Chrome * Microsoft Edge * Mozilla Firefox diff --git a/docs/additional-documentation/code-editor.html b/docs/additional-documentation/code-editor.html index 40581736..998b5283 100644 --- a/docs/additional-documentation/code-editor.html +++ b/docs/additional-documentation/code-editor.html @@ -123,14 +123,14 @@ NgxEditorModule
  • Components