Skip to content

Commit 2a370d9

Browse files
committed
update readme
1 parent 9111bbf commit 2a370d9

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
11

22
# Fusio SDK Angular
33

4-
This SDK provides several components and services which help to integrate
5-
Fusio into an existing Angular app.
4+
The Angular SDK provides several components and services which help to integrate Fusio into
5+
an Angular app. It provides two Angular libraries:
66

7-
## Setup
7+
* [fusio-sdk](https://www.npmjs.com/package/ngx-fusio-sdk)
8+
* [fusio-product](https://www.npmjs.com/package/ngx-fusio-product)
89

9-
This SDK provides a flexible way to build Angular apps using Fusio as backend.
10-
If you use this service in your project you need to create a custom `FusioService`
11-
which extends from the `FusioService` in this SDK s.
10+
## SDK
11+
12+
The SDK library provides a flexible way to build Angular apps using Fusio as backend.
13+
It is used by many Fusio related apps i.e. the [backend](https://github.com/apioo/fusio-apps-backend)
14+
and [developer](https://github.com/apioo/fusio-apps-developer) app.
15+
16+
To use this library in your project you need to create a custom `FusioService` which
17+
extends from the `FusioService` in this SDK s.
1218

1319
```typescript
1420
import {Injectable} from '@angular/core';
@@ -29,10 +35,11 @@ export class FusioService extends Sdk<Client> {
2935

3036
```
3137

32-
There we define which generated Client we use. In this example we use the generated Client for our backend API
33-
but you can also use the Client for your own API. You can then use this `FusioService` in every component.
34-
Then you also need to import the `FusioSdkModule` and overwrite the `FusioService` with your
35-
custom implementation so that the internal SDK also uses your `FusioService`.
38+
There we define which generated Client we use. In this example we use the generated Client for
39+
our backend API but you can also use the Client for your own API. You can then use this
40+
`FusioService` in every component. Then you also need to import the `FusioSdkModule` and
41+
overwrite the `FusioService` with your custom implementation so that the internal SDK also
42+
uses your `FusioService`.
3643

3744
```typescript
3845
import {FusioService} from "./fusio.service";
@@ -52,3 +59,7 @@ import {FusioSdkModule, FusioService as Sdk} from "ngx-fusio-sdk";
5259
//...
5360
})
5461
```
62+
63+
## Product
64+
65+
The product library provides components to create a product website for a Fusio project.

0 commit comments

Comments
 (0)