Skip to content

Commit

Permalink
docs: update README with peerDependencies
Browse files Browse the repository at this point in the history 
closes #92
  • Loading branch information
@sibiraj-s
sibiraj-s committed Apr 10, 2018
1 parent 3801c5c commit 1c316cb
Show file tree
Hide file tree
Showing 29 changed files with 506 additions and 384 deletions.
10 changes: 10 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
16 changes: 8 additions & 8 deletions docs/additional-documentation/code-editor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -148,14 +148,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down Expand Up @@ -331,14 +331,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -356,14 +356,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down
16 changes: 8 additions & 8 deletions docs/additional-documentation/colors.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -148,14 +148,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down Expand Up @@ -331,14 +331,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -356,14 +356,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down
16 changes: 8 additions & 8 deletions docs/additional-documentation/configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,14 +123,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -148,14 +148,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="xs-injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="xs-injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down Expand Up @@ -331,14 +331,14 @@
<a href="modules/NgxEditorModule.html" data-type="entity-link">NgxEditorModule</a>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-cogs"></span>
<span>Components</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="components-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="components-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="components/NgxEditorComponent.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules">NgxEditorComponent</a>
Expand All @@ -356,14 +356,14 @@
</li>
<li class="chapter inner">
<div class="simple menu-toggler" data-toggle="collapse"
data-target="#injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
data-target="#injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<span class="fa fa-fw fa-long-arrow-down"></span>
<span>Injectables</span>
<span class="fa fa-angle-down"></span>
</div>
<ul class="links collapse"
id="injectables-links-module-NgxEditorModule-1ddac1fb-3a51-4255-aee3-68f4a9bd9c7c"
id="injectables-links-module-NgxEditorModule-390ace5e-7e5e-4ba2-bc67-8b12f38b704c"
>
<li class="link">
<a href="injectables/CommandExecutorService.html" data-type="entity-link" data-context="sub-entity" data-context-id="modules"}>CommandExecutorService</a>
Expand Down
Loading

0 comments on commit 1c316cb

Please sign in to comment.