kritzel-angular 0.0.36 → 0.0.37

package/README.md

@@ -1,24 +1,33 @@
-# Lib
-
-This library was generated with [Angular CLI](https://github.com/angular/angular-cli) version 17.3.0.
-
-## Code scaffolding
-
-Run `ng generate component component-name --project lib` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module --project lib`.
-> Note: Don't forget to add `--project lib` or else it will be added to the default project in your `angular.json` file. 
-
-## Build
-
-Run `ng build lib` to build the project. The build artifacts will be stored in the `dist/` directory.
-
-## Publishing
-
-After building your library with `ng build lib`, go to the dist folder `cd dist/lib` and run `npm publish`.
-
-## Running unit tests
-
-Run `ng test lib` to execute the unit tests via [Karma](https://karma-runner.github.io).
-
-## Further help
-
-To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI Overview and Command Reference](https://angular.io/cli) page.
+# Setup 
+Install the kritzel-angular package
+```
+npm i kritzel-angular
+```
+
+Add LibModule to the providers array in your app.config.ts
+```typescript
+import  { LibModule } from 'kritzel-angular';
+
+export const appConfig: ApplicationConfig = {
+  providers: [
+     importProvidersFrom(LibModule.forRoot())
+  ]
+};
+```
+
+Include the LibModule into the imports array of your component to use Kritzel components in you template.
+
+```typescript
+import { LibModule } from 'kritzel-angular';
+
+@Component({
+  selector: 'my-component',
+  standalone: true,
+  imports: [LibModule],
+  template: `
+    <my-list></my-list>
+  `,
+})
+export class MyComponent {
+}
+```

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "kritzel-angular",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "peerDependencies": {
     "@angular/common": "^18.2.10",
     "@angular/core": "^18.2.10",
-    "kritzel-stencil": "^0.0.16"
+    "kritzel-stencil": "^0.0.37"
   },
   "dependencies": {
     "tslib": "^2.3.0"