Skip to content

Commit dc7add0

Browse files
committed
fix: user new library name in documentation
1 parent 5004435 commit dc7add0

File tree

5 files changed

+28
-28
lines changed

5 files changed

+28
-28
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you want to open a PR that fixes a bug or adds a feature, then we can't thank
1010

1111
## Submitting pull requests
1212

13-
### Modifying react-native-flutterwave
13+
### Modifying flutterwave-react-native
1414
1. Fork this repository
1515
2. Clone your fork
1616
3. Make a branch for your feature or bug fix (i.e. `git checkout -b what-im-adding`)
@@ -20,12 +20,12 @@ If you want to open a PR that fixes a bug or adds a feature, then we can't thank
2020
Depending on the changes you make you might want to test to see if the feature/fix works correctly.
2121
Use the following steps to test your newly added feature/fix.
2222
1. Set up your react-native example project or use one you already have.
23-
2. Create a `.env` file in the root of the library (react-native-flutterwave).
23+
2. Create a `.env` file in the root of the library (flutterwave-react-native).
2424
3. Add **RN_FLW_EXAMPLE_PROJECT** to the `.env` file it's value should be an absolute path to the install destination in your example project.
2525
**E.g.** `RN_FLW_EXAMPLE_PROJECT="/Users/your-name/projects/example-project/src"`.
2626
4. Run the following command `npm run set-example`.
2727

28-
Following these steps will result in you building and copy the built version of the library in the following directory `/Users/your-name/projects/example-project/src/react-native-flutterwave`, you can then go ahead an import the library from within your example project from the location the library has been copied to.
28+
Following these steps will result in you building and copy the built version of the library in the following directory `/Users/your-name/projects/example-project/src/flutterwave-react-native`, you can then go ahead an import the library from within your example project from the location the library has been copied to.
2929

3030
### Writting Tests
3131
We currently don't have strict rules for writting tests but when writting one be sure to make your tests and their captions clear and coincise, test only what you added, and then follow up with the dependencies if need be.

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Easily implement Flutterwave for payments in your React Native appliction. This
4747
This version of the library's docs focuses on use cases with the Version 3 of Flutterwaves API, if you are still using the Version 2 API please use [this documentation](./README.v2.md) instead.
4848

4949
## Installation
50-
This library is available on npm, you can install it by running `npm install --save react-native-flutterwave` or `yarn add react-native-flutterwave`
50+
This library is available on npm, you can install it by running `npm install --save flutterwave-react-native` or `yarn add flutterwave-react-native`
5151

5252
### Dependencies
5353
In order to render the Flutterwave checkout screen this library depends on [react-native-webview](https://github.com/react-native-community/react-native-webview) ensure you properly install this library before continuing.
@@ -79,10 +79,10 @@ Below are a few examples showcasing how you can use the library to implement pay
7979

8080
[View All Props](#flutterwavebuttonprops)
8181

82-
Import `PayWithFlutterwave` from `react-native-flutterwave` and use it like so.
82+
Import `PayWithFlutterwave` from `flutterwave-react-native` and use it like so.
8383
````jsx
84-
import {PayWithFlutterwave} from 'react-native-flutterwave';
85-
// or import PayWithFlutterwave from 'react-native-flutterwave';
84+
import {PayWithFlutterwave} from 'flutterwave-react-native';
85+
// or import PayWithFlutterwave from 'flutterwave-react-native';
8686

8787
<PayWithFlutterwave
8888
...
@@ -105,10 +105,10 @@ import {PayWithFlutterwave} from 'react-native-flutterwave';
105105

106106
[View All Props](#flutterwavebuttonprops)
107107

108-
Import `PayWithFlutterwave` from `react-native-flutterwave` and use it like so.
108+
Import `PayWithFlutterwave` from `flutterwave-react-native` and use it like so.
109109
````jsx
110-
import {PayWithFlutterwave} from 'react-native-flutterwave';
111-
// or import PayWithFlutterwave from 'react-native-flutterwave';
110+
import {PayWithFlutterwave} from 'flutterwave-react-native';
111+
// or import PayWithFlutterwave from 'flutterwave-react-native';
112112

113113
<PayWithFlutterwave
114114
...
@@ -131,9 +131,9 @@ import {PayWithFlutterwave} from 'react-native-flutterwave';
131131

132132
[View All Props](#flutterwavebuttonprops)
133133

134-
Import `FlutterwaveButton` from `react-native-flutterwave` and use it like so.
134+
Import `FlutterwaveButton` from `flutterwave-react-native` and use it like so.
135135
````jsx
136-
import {FlutterwaveButton} from 'react-native-flutterwave';
136+
import {FlutterwaveButton} from 'flutterwave-react-native';
137137

138138
<FlutterwaveButton
139139
style={styles.paymentButton}
@@ -146,9 +146,9 @@ import {FlutterwaveButton} from 'react-native-flutterwave';
146146
### FlutterwaveInit
147147
When called, this function returns a Promise which resolves to a string on success and rejects if an error occurs. [See all config options](#flutterwaveinitoptions)
148148

149-
Import `FlutterwaveInit` from `react-native-flutterwave` and use it like so.
149+
Import `FlutterwaveInit` from `flutterwave-react-native` and use it like so.
150150
````javascript
151-
import {FlutterwaveInit} from 'react-native-flutterwave';
151+
import {FlutterwaveInit} from 'flutterwave-react-native';
152152

153153
try {
154154
// initialize payment

README.v2.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Easily implement Flutterwave for payments in your React Native appliction. This
4444
This version of the library's docs focuses on use cases with the Version 2 of Flutterwaves API, if you are using the Version 3 API please use [this documentation](./README.md) instead.
4545

4646
## Installation
47-
This library is available on npm, you can install it by running `npm install --save react-native-flutterwave` or `yarn add react-native-flutterwave`
47+
This library is available on npm, you can install it by running `npm install --save flutterwave-react-native` or `yarn add flutterwave-react-native`
4848

4949
### Dependencies
5050
In order to render the Flutterwave checkout screen this library depends on [react-native-webview](https://github.com/react-native-community/react-native-webview) ensure you properly install this library before continuing.
@@ -76,10 +76,10 @@ Below are a few examples showcasing how you can use the library to implement pay
7676

7777
[View All Props](#flutterwavebuttonprops)
7878

79-
Import `PayWithFlutterwaveV2` from `react-native-flutterwave` and use it like so.
79+
Import `PayWithFlutterwaveV2` from `flutterwave-react-native` and use it like so.
8080
````jsx
81-
import {PayWithFlutterwaveV2} from 'react-native-flutterwave';
82-
// or import PayWithFlutterwaveV2 from 'react-native-flutterwave/PayWithFlutterwaveV2';
81+
import {PayWithFlutterwaveV2} from 'flutterwave-react-native';
82+
// or import PayWithFlutterwaveV2 from 'flutterwave-react-native/PayWithFlutterwaveV2';
8383

8484
<PayWithFlutterwaveV2
8585
...
@@ -99,10 +99,10 @@ import {PayWithFlutterwaveV2} from 'react-native-flutterwave';
9999

100100
[View All Props](#flutterwavebuttonprops)
101101

102-
Import `PayWithFlutterwaveV2` from `react-native-flutterwave` and use it like so.
102+
Import `PayWithFlutterwaveV2` from `flutterwave-react-native` and use it like so.
103103
````jsx
104-
import {PayWithFlutterwaveV2} from 'react-native-flutterwave';
105-
// or import PayWithFlutterwaveV2 from 'react-native-flutterwave/PayWithFlutterwaveV2';
104+
import {PayWithFlutterwaveV2} from 'flutterwave-react-native';
105+
// or import PayWithFlutterwaveV2 from 'flutterwave-react-native/PayWithFlutterwaveV2';
106106

107107
<PayWithFlutterwaveV2
108108
...
@@ -125,9 +125,9 @@ import {PayWithFlutterwaveV2} from 'react-native-flutterwave';
125125

126126
[View All Props](#flutterwavebuttonprops)
127127

128-
Import `FlutterwaveButton` from `react-native-flutterwave` and use it like so.
128+
Import `FlutterwaveButton` from `flutterwave-react-native` and use it like so.
129129
````jsx
130-
import {FlutterwaveButton} from 'react-native-flutterwave';
130+
import {FlutterwaveButton} from 'flutterwave-react-native';
131131

132132
<FlutterwaveButton
133133
style={styles.paymentButton}
@@ -140,10 +140,10 @@ import {FlutterwaveButton} from 'react-native-flutterwave';
140140
### FlutterwaveInitV2
141141
When called, this function returns a Promise which resolves to a string on success and rejects if an error occurs. [See all config options](#flutterwaveinitv2options)
142142

143-
Import `FlutterwaveInitV2` from `react-native-flutterwave` and use it like so.
143+
Import `FlutterwaveInitV2` from `flutterwave-react-native` and use it like so.
144144
````javascript
145-
import {FlutterwaveInitV2} from 'react-native-flutterwave';;
146-
// or import FlutterwaveInitV2 from 'react-native-flutterwave/FlutterwaveInitV2';
145+
import {FlutterwaveInitV2} from 'flutterwave-react-native';;
146+
// or import FlutterwaveInitV2 from 'flutterwave-react-native/FlutterwaveInitV2';
147147

148148
// initialize a new payment
149149
const payment = await FlutterwaveInitV2({

docs/AbortingPaymentInitialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
````jsx
77
import React from 'react';
88
import {View, TouchableOpacity} from 'react-native';
9-
import {FlutterwaveInit} from 'react-native-flutterwave';
9+
import {FlutterwaveInit} from 'flutterwave-react-native';
1010

1111
class MyCart extends React.Component {
1212
abortController = null;

docs/v2/AbortingPaymentInitialization.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
````jsx
77
import React from 'react';
88
import {View, TouchableOpacity} from 'react-native';
9-
import {FlutterwaveInitV2} from 'react-native-flutterwave';
9+
import {FlutterwaveInitV2} from 'flutterwave-react-native';
1010

1111
class MyCart extends React.Component {
1212
abortController = null;

0 commit comments

Comments
 (0)