Skip to content
This repository has been archived by the owner on Aug 1, 2024. It is now read-only.

Commit

Permalink
fix: update readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
artemnih committed Mar 7, 2022
1 parent d0ca6e0 commit b2f1d30
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 2 deletions.
36 changes: 35 additions & 1 deletion projects/ngx-explorer/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,36 @@
# ngx-explorer
Simple Angular File Explorer module. Plug and Play... almost
Lightweight and easy-to-use Angular File Explorer module.
This is a front-end implementation only. There are no services at this point.

[DEMO](https://artemnih.github.io/ngx-explorer/)

## How to use
- Install package
```
npm i ngx-explorer
```
- Implement `IDataService` provider interface
```Typescript
import { IDataService } from 'ngx-explorer';

export class MyDataService implements IDataService<MyNodeType> {
...
}
```
- Add `NgxExplorerModule` and data provider to `NgModule`
```Typescript
import { NgxExplorerModule, DataService } from 'ngx-explorer';

@NgModule({
imports: [
...
NgxExplorerModule
],
providers: [
{ provide: DataService, useClass: MyDataService }
]
})
export class AppModule { }
```

![explorer](docs/ss.png)
2 changes: 1 addition & 1 deletion projects/ngx-explorer/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ngx-explorer",
"version": "0.0.4",
"version": "0.0.5",
"peerDependencies": {
"@angular/common": ">= 10.0.0",
"@angular/core": ">= 10.0.0",
Expand Down

0 comments on commit b2f1d30

Please sign in to comment.