Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianRappl committed Nov 21, 2023
1 parent acc04d7 commit f30d158
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- Fixed issue when target tarball is part of tarball content in `pilet pack` (#642)
- Moved `piral-jest-utils` and `piral-ie11polyfills-utils` into a separate repository
- Updated documentation on `piral-ng` (#646)
- Updated dependencies (#641)
- Updated generated code to fully use ES2020
- Added `piral-react` as converter for React
Expand Down
6 changes: 3 additions & 3 deletions src/converters/piral-ng/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,13 @@ export function setup(piral: PiletApi) {
}
```

We recommend that you still put these components into modules as you would normally do. In order for Piral to use that module you need to define it first. This also allows you to use special Piral declarations such as the `NgExtension` or the `ResourceUrlPipe`. All these declarations come with the `SharedModule` available via import from `piral-ng/common`.
We recommend that you still put these components into modules as you would normally do. In order for Piral to use that module you need to define it first. This also allows you to use special Piral declarations such as the `NgExtension` or the `ResourceUrlPipe`. All these declarations come with the `SharedModule` available via import from `piral-ng-common`.

Example (app) module:

```ts
import { NgModule } from '@angular/core';
import { SharedModule } from 'piral-ng/common';
import { SharedModule } from 'piral-ng-common';
import { AngularPage } from './AngularPage';

@NgModule({
Expand Down Expand Up @@ -347,7 +347,7 @@ The related packages should be shared with the pilets via the *package.json*:
"@angular/core": "",
"@angular/platform-browser": "",
"@angular/platform-browser-dynamic": "",
"piral-ng/common": "",
"piral-ng-common": "",
"rxjs": "",
"zone.js": ""
}
Expand Down

0 comments on commit f30d158

Please sign in to comment.