Skip to content

Commit 978f4b5

Browse files
Update README.md
1 parent 7829e77 commit 978f4b5

File tree

1 file changed

+36
-29
lines changed

1 file changed

+36
-29
lines changed

README.md

Lines changed: 36 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,31 @@
22
<img title="Flutterwave" height="200" src="https://flutterwave.com/images/logo-colored.svg" width="50%"/>
33
</p>
44

5-
# flutterwave-react-v3
5+
## Table of Contents
66

7-
This is a react package for implementing Flutterwave collection gateway
7+
- [About](#about)
8+
- [Getting Started](#getting-started)
9+
- [Usage](#usage)
10+
- [Deployment](#deployment)
11+
- [Built Using](#build-tools)
12+
- [References](#references)
813

9-
## Demo
1014

11-
![Alt text](React_App.png?raw=true "Demo Image")
15+
<a id="about"></a>
1216

13-
## Installation
17+
## About
18+
19+
This is a react package for implementing Flutterwave gateway with different payment methods.
20+
21+
<a id="getting-started"></a>
22+
23+
## Getting Started
24+
25+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
26+
See [references](#references) for links to dashboard and API documentation.
27+
28+
29+
### Installation
1430

1531
```bash
1632
$ npm install flutterwave-react-v3
@@ -22,7 +38,7 @@ $ yarn add flutterwave-react-v3
2238

2339
```
2440

25-
### Usage
41+
## Usage
2642

2743
### Hooks
2844

@@ -116,37 +132,28 @@ export default function App() {
116132
}
117133
```
118134

119-
Please checkout
120-
[Flutterwave Documentation](https://developer.flutterwave.com/docs/flutterwave-standard)
121-
for other available options you can add to the tag
122-
123-
## License
124-
125-
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE)
126-
file for details
135+
Please checkout [Flutterwave Documentation](https://developer.flutterwave.com/docs/flutterwave-standard) for other available options you can add to the tag.
127136

128-
## Contributions ✨
129137

130-
1. Fork it!
131-
2. Create your feature branch: `git checkout -b feature-name`
132-
3. Commit your changes: `git commit -am 'Some commit message'`
133-
4. Push to the branch: `git push origin feature-name`
134-
5. Submit a pull request
138+
<a id="deployment"></a>
135139

140+
## Deployment
136141

137-
This project follows the
138-
[all-contributors](https://github.com/all-contributors/all-contributors)
139-
specification. Contributions of any kind welcome!
142+
- Switch to Live Mode on the Dashboard settings page
143+
- Use the Live Public API key
140144

145+
<a id="build-tools"></a>
146+
## Built Using
141147

142-
### Issues
148+
- [Typescript](https://www.typescriptlang.org/)
149+
- React
143150

144-
Looking to contribute? Look for the Good First Issue label.
145151

146-
### 🐛 Bugs
152+
<a id="references"></a>
147153

148-
Please file an issue for bugs, missing documentation, or unexpected behavior.
154+
## Flutterwave API References
149155

150-
## License
156+
- [Flutterwave API Doc](https://developer.flutterwave.com/docs)
157+
- [Flutterwave Inline Payment Doc](https://developer.flutterwave.com/docs/flutterwave-inline)
158+
- [Flutterwave Dashboard](https://dashboard.flutterwave.com/login)
151159

152-
MIT

0 commit comments

Comments
 (0)