Restored initialization section to README.md file

Flutterwave · Jul 12, 2024 · a6a7803 · a6a7803
1 parent ffe47d0
commit a6a7803
Show file tree

Hide file tree

Showing 4 changed files with 111 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -21,11 +21,12 @@ Available features include:
 
 1. [Requirements](#requirements)
 2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Support](#support)
-5. [Contribution Guidelines](#contribution-guidelines)
-6. [License](#license)
-7. [Changelog](#)
+3. [Initialization](#Initialization)
+4. [Usage](#usage)
+5. [Support](#support)
+6. [Contribution Guidelines](#contribution-guidelines)
+7. [License](#license)
+8. [Changelog](#)
 
 ## Requirements
 
@@ -43,6 +44,35 @@ $ npm install flutterwave-angular-v3
 $ yarn add flutterwave-angular-v3
 ```
 
+## Initialization
+
+Import FlutterwaveModule to the app root module
+
+```typescript
+import { FlutterwaveModule } from "flutterwave-angular-v3"
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    FlutterwaveModule
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+```
+
+> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
+Kindly include the following line in tsconfig.app.json under `compilerOptions` :
+
+```
+paths": { "@angular/*": [ "node_modules/@angular/*" ] }
+```
+
+Then restart server and try again
+
 ## Usage
 
 Add Flutterwave to your project as a component or directly in your code:

diff --git a/dist/flutterwave-angular-v3/README.md b/dist/flutterwave-angular-v3/README.md
@@ -3,8 +3,6 @@
 </p>
 
 # Flutterwave Angular Library
-
-![Node.js Package](https://github.com/Flutterwave/Flutterwave-Angular-v3/workflows/Node.js%20Package/badge.svg)
 ![npm](https://img.shields.io/npm/v/flutterwave-angular-v3)
 ![npm](https://img.shields.io/npm/dt/flutterwave-angular-v3)
 ![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
 
 Available features include:
 
-- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
+- Collections: Card, Account, Mobile Money, Bank Transfers, USSD, Barter, NQR.
 - Recurring payments: Tokenization and Subscriptions.
 - Split payments
 
 ## Table of Contents
 
 1. [Requirements](#requirements)
 2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Support](#support)
-5. [Contribution Guidelines](#contribution-guidelines)
-6. [License](#license)
-7. [Changelog](#)
+3. [Initialization](#Initialization)
+4. [Usage](#usage)
+5. [Support](#support)
+6. [Contribution Guidelines](#contribution-guidelines)
+7. [License](#license)
+8. [Changelog](#)
 
 ## Requirements
 
 1. Flutterwave version 3 API keys
 2. Node version >= 14.15.0 and npm >= 6.14.8
-3. Angular version  >= 18
+3. Angular version  >= 18.
 
 ## Installation
 
@@ -45,6 +44,35 @@ $ npm install flutterwave-angular-v3
 $ yarn add flutterwave-angular-v3
 ```
 
+## Initialization
+
+Import FlutterwaveModule to the app root module
+
+```typescript
+import { FlutterwaveModule } from "flutterwave-angular-v3"
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    FlutterwaveModule
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+```
+
+> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
+Kindly include the following line in tsconfig.app.json under `compilerOptions` :
+
+```
+paths": { "@angular/*": [ "node_modules/@angular/*" ] }
+```
+
+Then restart server and try again
+
 ## Usage
 
 Add Flutterwave to your project as a component or directly in your code:

diff --git a/package-lock.json b/package-lock.json
diff --git a/projects/flutterwave-angular-v3/README.md b/projects/flutterwave-angular-v3/README.md
@@ -3,8 +3,6 @@
 </p>
 
 # Flutterwave Angular Library
-
-![Node.js Package](https://github.com/Flutterwave/Flutterwave-Angular-v3/workflows/Node.js%20Package/badge.svg)
 ![npm](https://img.shields.io/npm/v/flutterwave-angular-v3)
 ![npm](https://img.shields.io/npm/dt/flutterwave-angular-v3)
 ![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
 
 Available features include:
 
-- Collections: Card, Account, Mobile money, Bank Transfers, USSD, Barter, NQR.
+- Collections: Card, Account, Mobile Money, Bank Transfers, USSD, Barter, NQR.
 - Recurring payments: Tokenization and Subscriptions.
 - Split payments
 
 ## Table of Contents
 
 1. [Requirements](#requirements)
 2. [Installation](#installation)
-3. [Usage](#usage)
-4. [Support](#support)
-5. [Contribution Guidelines](#contribution-guidelines)
-6. [License](#license)
-7. [Changelog](#)
+3. [Initialization](#Initialization)
+4. [Usage](#usage)
+5. [Support](#support)
+6. [Contribution Guidelines](#contribution-guidelines)
+7. [License](#license)
+8. [Changelog](#)
 
 ## Requirements
 
 1. Flutterwave version 3 API keys
 2. Node version >= 14.15.0 and npm >= 6.14.8
-3. Angular version  >= 18
+3. Angular version  >= 18.
 
 ## Installation
 
@@ -45,6 +44,35 @@ $ npm install flutterwave-angular-v3
 $ yarn add flutterwave-angular-v3
 ```
 
+## Initialization
+
+Import FlutterwaveModule to the app root module
+
+```typescript
+import { FlutterwaveModule } from "flutterwave-angular-v3"
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [
+    BrowserModule,
+    FlutterwaveModule
+  ],
+  providers: [],
+  bootstrap: [AppComponent]
+})
+```
+
+> NB: If you experience compilation errors in your app after importing the Flutterwave module, component or service.
+Kindly include the following line in tsconfig.app.json under `compilerOptions` :
+
+```
+paths": { "@angular/*": [ "node_modules/@angular/*" ] }
+```
+
+Then restart server and try again
+
 ## Usage
 
 Add Flutterwave to your project as a component or directly in your code: