Skip to content

Commit 03194ed

Browse files
update structure and content of developer docs
1 parent 2e24eff commit 03194ed

File tree

1 file changed

+8
-30
lines changed

1 file changed

+8
-30
lines changed

README.md

+8-30
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Available features include:
2020
- Recurring payments: Tokenization and Subscriptions.
2121
- Split payments
2222

23+
2324
## Table of Contents
2425

2526
1. [Requirements](#requirements)
@@ -29,20 +30,17 @@ Available features include:
2930
5. [Support](#support)
3031
6. [Contribution Guidelines](#contribution-guidelines)
3132
7. [License](#license)
33+
8. [Contributors](#contributors)
34+
9. [Changelog](#)
3235

3336

34-
35-
<a id="requirements"></a>
36-
3737
## Requirements
3838

3939
1. Flutterwave version 3 API keys
4040
2. Node version >= 6.9.x and npm >= 3.x.x
4141
3. React version >= 14
4242

4343

44-
<a id="installation"></a>
45-
4644
## Installation
4745

4846
Install the SDK
@@ -56,7 +54,6 @@ $ yarn add flutterwave-react-v3
5654
```
5755

5856

59-
<a id="initialization"></a>
6057
## Initialization
6158

6259
Import useFlutterwave to any component in your application and pass your config
@@ -85,18 +82,16 @@ import { useFlutterwave } from 'flutterwave-react-v3';
8582

8683
```
8784

88-
<a id="usage"></a>
89-
9085

9186
## Usage
9287

93-
You can use Flutterwave in your projects as a component or as a react Hooks:
88+
Add Flutterwave to your projects as a component or a react hook:
9489

95-
1. [As a Component](#using-flutterwave-as-a-component)
96-
2. [Directly in your code](#using-flutterwave-as-a-hook)
90+
1. [As a Component](#components)
91+
2. [Directly in your code](#hooks)
92+
3. [Making recurrent payments](#recurring-payments)
9793

9894

99-
<a id="using-flutterwave-as-a-component"></a>
10095
### Components
10196

10297
```javascript
@@ -142,8 +137,6 @@ export default function App() {
142137
```
143138

144139

145-
<a id="using-flutterwave-as-a-hook"></a>
146-
147140
### Hooks
148141

149142
```javascript
@@ -287,15 +280,14 @@ We understand that you may run into some errors while integrating our library. Y
287280
For `authorization` and `validation` error responses, double-check your API keys and request. If you get a `server` error, kindly engage the team for support.
288281

289282

290-
<a id="support"></a>
291283

292284
# Support
293285

294286
For additional assistance using this library, please create an issue on the Github repo or contact the developer experience (DX) team via [email](mailto:[email protected]) or on [slack](https://bit.ly/34Vkzcg).
295287

296288
You can also follow us [@FlutterwaveEng](https://twitter.com/FlutterwaveEng) and let us know what you think 😊.
297289

298-
<a id="contribution-guidelines"></a>
290+
299291

300292
## Contribution Guidelines
301293

@@ -312,20 +304,6 @@ Copyright (c) Flutterwave Inc.
312304

313305

314306

315-
## Built Using
316-
317-
- [Typescript](https://www.typescriptlang.org/)
318-
- React
319-
320-
321307
## Contributors
322308

323309
- [Somto Ugeh](https://twitter.com/SomtoUgeh)
324-
325-
326-
## Flutterwave API References
327-
328-
- [Flutterwave API Doc](https://developer.flutterwave.com/docs)
329-
- [Flutterwave Inline Payment Doc](https://developer.flutterwave.com/docs/flutterwave-inline)
330-
- [Flutterwave Dashboard](https://dashboard.flutterwave.com/login)
331-

0 commit comments

Comments
 (0)