Skip to content

Commit a6a7803

Browse files
committed
Restored initialization section to README.md file
1 parent ffe47d0 commit a6a7803

File tree

4 files changed

+111
-25
lines changed

4 files changed

+111
-25
lines changed

README.md

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,12 @@ Available features include:
2121

2222
1. [Requirements](#requirements)
2323
2. [Installation](#installation)
24-
3. [Usage](#usage)
25-
4. [Support](#support)
26-
5. [Contribution Guidelines](#contribution-guidelines)
27-
6. [License](#license)
28-
7. [Changelog](#)
24+
3. [Initialization](#Initialization)
25+
4. [Usage](#usage)
26+
5. [Support](#support)
27+
6. [Contribution Guidelines](#contribution-guidelines)
28+
7. [License](#license)
29+
8. [Changelog](#)
2930

3031
## Requirements
3132

@@ -43,6 +44,35 @@ $ npm install flutterwave-angular-v3
4344
$ yarn add flutterwave-angular-v3
4445
```
4546

47+
## Initialization
48+
49+
Import FlutterwaveModule to the app root module
50+
51+
```typescript
52+
import { FlutterwaveModule } from "flutterwave-angular-v3"
53+
54+
@NgModule({
55+
declarations: [
56+
AppComponent
57+
],
58+
imports: [
59+
BrowserModule,
60+
FlutterwaveModule
61+
],
62+
providers: [],
63+
bootstrap: [AppComponent]
64+
})
65+
```
66+
67+
> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
68+
Kindly include the following line in tsconfig.app.json under `compilerOptions` :
69+
70+
```
71+
paths": { "@angular/*": [ "node_modules/@angular/*" ] }
72+
```
73+
74+
Then restart server and try again
75+
4676
## Usage
4777

4878
Add Flutterwave to your project as a component or directly in your code:

dist/flutterwave-angular-v3/README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
</p>
44

55
# Flutterwave Angular Library
6-
7-
![Node.js Package](https://github.com/Flutterwave/Flutterwave-Angular-v3/workflows/Node.js%20Package/badge.svg)
86
![npm](https://img.shields.io/npm/v/flutterwave-angular-v3)
97
![npm](https://img.shields.io/npm/dt/flutterwave-angular-v3)
108
![NPM](https://img.shields.io/npm/l/flutterwave-angular-v3)
@@ -15,25 +13,26 @@ The Angular SDK helps you create seamless payment experiences in your Angular mo
1513

1614
Available features include:
1715

18-
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
16+
- Collections: Card, Account, Mobile Money, Bank Transfers, USSD, Barter, NQR.
1917
- Recurring payments: Tokenization and Subscriptions.
2018
- Split payments
2119

2220
## Table of Contents
2321

2422
1. [Requirements](#requirements)
2523
2. [Installation](#installation)
26-
3. [Usage](#usage)
27-
4. [Support](#support)
28-
5. [Contribution Guidelines](#contribution-guidelines)
29-
6. [License](#license)
30-
7. [Changelog](#)
24+
3. [Initialization](#Initialization)
25+
4. [Usage](#usage)
26+
5. [Support](#support)
27+
6. [Contribution Guidelines](#contribution-guidelines)
28+
7. [License](#license)
29+
8. [Changelog](#)
3130

3231
## Requirements
3332

3433
1. Flutterwave version 3 API keys
3534
2. Node version >= 14.15.0 and npm >= 6.14.8
36-
3. Angular version >= 18
35+
3. Angular version >= 18.
3736

3837
## Installation
3938

@@ -45,6 +44,35 @@ $ npm install flutterwave-angular-v3
4544
$ yarn add flutterwave-angular-v3
4645
```
4746

47+
## Initialization
48+
49+
Import FlutterwaveModule to the app root module
50+
51+
```typescript
52+
import { FlutterwaveModule } from "flutterwave-angular-v3"
53+
54+
@NgModule({
55+
declarations: [
56+
AppComponent
57+
],
58+
imports: [
59+
BrowserModule,
60+
FlutterwaveModule
61+
],
62+
providers: [],
63+
bootstrap: [AppComponent]
64+
})
65+
```
66+
67+
> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
68+
Kindly include the following line in tsconfig.app.json under `compilerOptions` :
69+
70+
```
71+
paths": { "@angular/*": [ "node_modules/@angular/*" ] }
72+
```
73+
74+
Then restart server and try again
75+
4876
## Usage
4977

5078
Add Flutterwave to your project as a component or directly in your code:

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/flutterwave-angular-v3/README.md

Lines changed: 37 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
</p>
44

55
# Flutterwave Angular Library
6-
7-
![Node.js Package](https://github.com/Flutterwave/Flutterwave-Angular-v3/workflows/Node.js%20Package/badge.svg)
86
![npm](https://img.shields.io/npm/v/flutterwave-angular-v3)
97
![npm](https://img.shields.io/npm/dt/flutterwave-angular-v3)
108
![NPM](https://img.shields.io/npm/l/flutterwave-angular-v3)
@@ -15,25 +13,26 @@ The Angular SDK helps you create seamless payment experiences in your Angular mo
1513

1614
Available features include:
1715

18-
- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
16+
- Collections: Card, Account, Mobile Money, Bank Transfers, USSD, Barter, NQR.
1917
- Recurring payments: Tokenization and Subscriptions.
2018
- Split payments
2119

2220
## Table of Contents
2321

2422
1. [Requirements](#requirements)
2523
2. [Installation](#installation)
26-
3. [Usage](#usage)
27-
4. [Support](#support)
28-
5. [Contribution Guidelines](#contribution-guidelines)
29-
6. [License](#license)
30-
7. [Changelog](#)
24+
3. [Initialization](#Initialization)
25+
4. [Usage](#usage)
26+
5. [Support](#support)
27+
6. [Contribution Guidelines](#contribution-guidelines)
28+
7. [License](#license)
29+
8. [Changelog](#)
3130

3231
## Requirements
3332

3433
1. Flutterwave version 3 API keys
3534
2. Node version >= 14.15.0 and npm >= 6.14.8
36-
3. Angular version >= 18
35+
3. Angular version >= 18.
3736

3837
## Installation
3938

@@ -45,6 +44,35 @@ $ npm install flutterwave-angular-v3
4544
$ yarn add flutterwave-angular-v3
4645
```
4746

47+
## Initialization
48+
49+
Import FlutterwaveModule to the app root module
50+
51+
```typescript
52+
import { FlutterwaveModule } from "flutterwave-angular-v3"
53+
54+
@NgModule({
55+
declarations: [
56+
AppComponent
57+
],
58+
imports: [
59+
BrowserModule,
60+
FlutterwaveModule
61+
],
62+
providers: [],
63+
bootstrap: [AppComponent]
64+
})
65+
```
66+
67+
> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
68+
Kindly include the following line in tsconfig.app.json under `compilerOptions` :
69+
70+
```
71+
paths": { "@angular/*": [ "node_modules/@angular/*" ] }
72+
```
73+
74+
Then restart server and try again
75+
4876
## Usage
4977

5078
Add Flutterwave to your project as a component or directly in your code:

0 commit comments

Comments
 (0)