Skip to content

Commit 7938d60

Browse files
committed
Update docs & contribution documentation.
1 parent 0c823ab commit 7938d60

File tree

2 files changed

+55
-43
lines changed

2 files changed

+55
-43
lines changed

CONTRIBUTING.md

+16-6
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,18 @@
1-
# Contribution
2-
Making contributions is really simple just follow the guidlines below;
1+
# Contribution Guidelines
32

4-
- Fork this project.
5-
- Each new feature must be a new PR.
6-
- Explain exactly what your PR is suppose to do.
3+
We’re excited to have you contribute! Here’s how to get started:
4+
5+
## Steps to Contribute
6+
7+
- Fork the Project: Start by forking this repository to your own GitHub account.
8+
- Create a New Branch: For each new feature or change, create a new branch from the `main` branch.
9+
- Make Your Changes: All modifications should be made exclusively in the `/development` directory.
10+
- Submit a Pull Request (PR): Once you’re satisfied with your changes, submit a PR. Be sure to provide a clear description of what your PR does and the problem it solves.
11+
12+
## Important Notes
13+
14+
- No Build Attempts in PRs: Please do not try to build the project within your PR; our Continuous Integration (CI) system will handle that for you.
15+
- Contributor Recognition: You do not need to add yourself as a contributor; the CI will automatically recognize and credit you once your PR is merged.
16+
17+
Thank you for helping us make this project even better! We appreciate your contributions!
718

8-
and that's it, your PR will be merged! thank in advance, lets make this awesome :)

README.md

+39-37
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,51 @@
1+
<div style="text-align: center;">
2+
13
# React Native Paystack WebView
2-
[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
3-
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
4-
4+
The package allows you accept payment using paystack, install, add keys and use. No stress :)
55

6-
The package allows you accept payment using paystack, install, add keys and use. No stress :)
6+
[![All Contributors](https://img.shields.io/badge/all_contributors-9-orange.svg?style=flat-square)](#contributors-)
7+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
78

8-
### [](https://github.com/just1and0/React-Native-Paystack-WebView#installation)Installation
9+
</div>
910

10-
Add React-Native-Paystack-WebView to your project by running;
1111

12-
`npm install react-native-paystack-webview`
12+
<div style="text-align: center;">
13+
<img width="306" alt="Screenshot of library in action" src="https://user-images.githubusercontent.com/41248079/126550307-5f12c6d8-81af-4f26-951b-5d6514304022.png">
14+
</div>
1315

14-
or
16+
1517

16-
`yarn add react-native-paystack-webview`
18+
### [](https://github.com/just1and0/React-Native-Paystack-WebView#installation)Installation
1719

18-
### **One more thing**
20+
Add `react-native-paystack-webView` to your project by running;
1921

20-
To frontload the installation work, let's also install and configure dependencies used by this project, being **react-native-webview**
22+
```bash
23+
npm install react-native-paystack-webview
2124

22-
run
25+
or
2326

24-
`yarn add react-native-webview`
27+
yarn add react-native-paystack-webview
28+
```
29+
### **Additional Setup**
2530

26-
for iOS: `cd iOS && pod install && cd ..`
31+
To ensure everything works smoothly, install and configure the required dependency, `react-native-webview`:
2732

33+
34+
```bash
35+
yarn add react-native-webview
36+
```
37+
for iOS:
38+
```bash
39+
cd iOS && pod install && cd ..
40+
```
2841
for expo applications run;
42+
```bash
43+
npx expo install react-native-webview
44+
```
45+
That’s it! You’re all set.
2946

30-
`npx expo install react-native-webview`
31-
32-
and that's it, you're all good to go!
33-
34-
<img width="306" alt="Screenshot of library in action" src="https://user-images.githubusercontent.com/41248079/126550307-5f12c6d8-81af-4f26-951b-5d6514304022.png">
35-
36-
### [](https://github.com/just1and0/React-Native-Paystack-WebView#usage)Usage 1
47+
### [](https://github.com/just1and0/React-Native-Paystack-WebView#usage)Usage
48+
##### Basic Example
3749

3850
```javascript
3951
import React from 'react';
@@ -61,9 +73,9 @@ function Pay() {
6173
}
6274
```
6375

64-
## Usage 2 - Using Refs
76+
##### Using Refs
6577

66-
Make use of a `ref` to start transaction. See example below;
78+
You can also use a `ref` to start a transaction. Here’s how:
6779

6880
```javascript
6981
import React, { useRef } from 'react';
@@ -96,9 +108,7 @@ function Pay(){
96108
}
97109
```
98110

99-
## API's
100-
101-
#### [](https://github.com/just1and0/object-to-array-convert#all-object-to-array-convert-props)all React-Native-Paystack-WebView API
111+
### [](https://github.com/just1and0/object-to-array-convert#all-object-to-array-convert-props) API Reference
102112

103113
| Name | use/description | extra |
104114
| :----------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | ---------------------------------------------------------: |
@@ -119,11 +129,11 @@ function Pay(){
119129

120130
## [](https://github.com/just1and0/object-to-array-convert#contributions)Contributions
121131

122-
Want to help make this package even more awesome? [Read how to contribute](https://github.com/just1and0/React-Native-Paystack-WebView/blob/master/CONTRIBUTING.md) and feel free to send in your PR!
132+
Want to help improve this package? [Read how to contribute](https://github.com/just1and0/React-Native-Paystack-WebView/blob/master/CONTRIBUTING.md) and feel free to submit your PR!
123133

124134
## [](https://github.com/just1and0/React-Native-Paystack-WebView#licensing)Licensing
125135

126-
This project is licensed under MIT license.
136+
This project is licensed under the MIT License.
127137

128138
## Related Projects
129139

@@ -178,12 +188,4 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
178188

179189
<!-- ALL-CONTRIBUTORS-LIST:END -->
180190

181-
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
182-
183-
184-
# Roadmap
185-
we have a lot to get done before we hit stable, here's a list;
186-
- Make the reference usage more user friendly
187-
- Since you want it to conform to InlineJS, let the variable names also match
188-
- Let the parameter types also conform to InlineJS parameter types
189-
- Paystack is a word, hence when used as a package name/class name, let it use PascalCase (Paystack) and when used as a variable, camelCase (paystack)
191+
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)