Skip to content

Commit

Permalink
feat: update and correct README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
osahner authored and jkuri committed Jun 19, 2018
1 parent a4f4701 commit 2746e9e
Showing 1 changed file with 48 additions and 7 deletions.
55 changes: 48 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,29 +16,70 @@ To save your and our time, we will systematically close all issues that are requ

1. Add `ngx-uploader` module as dependency to your project.

```
```bash
npm install ngx-uploader --save
```

2. Include `NgUploaderModule` into your main AppModule or in module where you will use it.
2. Include `NgxUploaderModule` into your main AppModule or in module where you will use it.

```
```ts
// app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { NgUploaderModule } from 'ngx-uploader';
import { NgxUploaderModule } from 'ngx-uploader';

@NgModule({
imports: [
BrowserModule,
NgUploaderModule
NgxUploaderModule
],
declarations: [ AppComponent ],
exports: [ AppComponent ]
declarations: [ AppComponent ]
})
export class AppModule {}
```

**or** include `NgxUploaderModule` with your SharedModule. This could be usefull if your project has nested Modules.

```ts
// shared.module.ts
import { NgModule } from '@angular/core';
import { CommonModule } from '@angular/common';
import { NgxUploaderModule } from 'ngx-uploader';
...

@NgModule({
imports: [
CommonModule,
NgxUploaderModule,
...
],
exports: [
CommonModule,
NgxUploaderModule,
...
],
...
})
export class SharedModule {
}

// app.module.ts
import { NgModule } from '@angular/core';
import { BrowserModule } from '@angular/platform-browser';
import { SharedModule } from './shared.module';

@NgModule({
imports: [
BrowserModule,
SharedModule
],
declarations: [ AppComponent ]
})
export class AppModule {}

````


## Data Structures of Events and Uploaded Files

```ts
Expand Down

0 comments on commit 2746e9e

Please sign in to comment.