Skip to content

Update install doc #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ebrehault wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update install doc #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,15 @@
To install this library, run:

```bash
$ npm install angular-medium-editor --save
$ npm install @kitconcept/angular-medium-editor --save
```

## Consuming your library

Once you have published your library to npm, you can import your library in any Angular application by running:

```bash
$ npm install angular-medium-editor
$ npm install @kitconcept/angular-medium-editor
```

and then from your Angular `AppModule`:
Expand All @@ -27,7 +27,7 @@ import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

// Import your library
import { MediumEditorModule } from 'angular-medium-editor';
import { MediumEditorModule } from '@kitconcept/angular-medium-editor';

@NgModule({
declarations: [
Expand All @@ -45,6 +45,16 @@ import { MediumEditorModule } from 'angular-medium-editor';
export class AppModule { }
```

You also need to load the Medium style. If you use the Angular CLI, `.angular-cli.json` is the place to do it:
```typescript
...
"styles": [
"styles.css",
"../node_modules/medium-editor/dist/css/medium-editor.min.css"
],
...
```

Once your library is imported, you can use the component like:

```xml
Expand Down