Skip to content

Commit 3beb35c

Browse files
committed
docs: add function removed in version 2
1 parent 13e8609 commit 3beb35c

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
On the server, wraps the component in a function to render it to a HTML string given its props.
66

7-
On the client, calling this function with your component scans the DOM for any server-side rendered instances of it. It then resumes those components using the server-specified props.
7+
On the client, uses the `HypernovaModuleFactory` to provide the metadata necessary to bootstrap the components.
8+
9+
**Note**: `renderAngular` and `mountComponent` are not supported anymore. They were removed to move the boostrapping responsability to the library consumer in order to support AOT and JIT compiling.
810

911
## Install
1012

@@ -17,7 +19,7 @@ npm install hypernova-angular
1719
Uses `renderAngular` to return hypernova bindings.
1820

1921
```ts
20-
import { renderAngular } from 'hypernova-angular'
22+
import { renderAngular } from 'hypernova-angular/server'
2123

2224
import { ExampleModule } from './components/example/example.module'
2325
import { ExampleComponent } from './components/example/example.component'
@@ -32,13 +34,14 @@ hypernova({
3234
```
3335
3436
## Browser Usage
35-
You can use [Ara CLI](https://github.com/ara-framework/ara-cli) to support client-side rendering.
37+
38+
You can use [Ara CLI](https://github.com/ara-framework/ara-cli) to create a service (Nova) with everything ready to start.
3639
3740
```bash
3841
ara new:nova -t angular
3942
```
4043
41-
Also, you can use the following configurations.
44+
Or, you can use the following configurations.
4245
4346
### App Module
4447
@@ -145,7 +148,7 @@ enableProdMode();
145148

146149
const render = (name: string, placeholder: any) => {
147150
const hypernovaModuleFactory = new HypernovaModuleFactory(AppModuleNgFactory, name, placeholder);
148-
platformBrowser().bootstrapModuleFactory();
151+
platformBrowser().bootstrapModuleFactory(hypernovaModuleFactory);
149152
}
150153

151154
document.addEventListener('NovaMount', (event) => {

0 commit comments

Comments
 (0)