chore: update readme

artemnih · Mar 7, 2022 · e51b4b3 · e51b4b3
1 parent 9220e19
commit e51b4b3
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,36 @@
 # ngx-explorer
 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)
diff --git a/docs/ss.png b/docs/ss.png