Skip to content

Commit 65ca10d

Browse files
2 parents 75a7bfb + ad95cbe commit 65ca10d

File tree

3 files changed

+53
-1
lines changed

3 files changed

+53
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ node_modules
44
# local env files
55
.env.local
66
.env.*.local
7+
todo.md
78

89
# Log files
910
npm-debug.log*

CONTRIBUTION.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
##Contribution and Development Docs
2+
3+
This guide contains steps on how to setup, contribute, build and publish to the Flutterwave Vue package.
4+
5+
The library is generated using 'vue-sfc-rollup' package . This package creates a set of files for building Vue libraries to simplify the build and deployment process.
6+
7+
###Get started
8+
9+
* Install the 'vue-sfc-rollup' package.
10+
11+
````ignorelang
12+
npm install -g vue-sfc-rollup
13+
````
14+
15+
* Pull down project from github.
16+
17+
* Run 'npm install' in project root folder
18+
```ignorelang
19+
npm install
20+
```
21+
22+
###File Structure
23+
The library code files are located in './src' folder
24+
25+
26+
###Code Contribution
27+
Please follow the guidelines below when adding features, components, etc to the library.
28+
29+
* Library files should be in the './src' folder
30+
31+
* Components should be created in the './src/lib-components' folder
32+
33+
* All components in the 'src/lib-components' folder should be exported in the 'src/lib-components/index.js'
34+
file
35+
36+
* Components are tested in the dev folder.
37+
38+
39+
###Build And Publish
40+
41+
To build, run :
42+
43+
```ignorelang
44+
npm run build
45+
```
46+
47+
To publish, run
48+
49+
```ignorelang
50+
npm publish
51+
```

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ $ yarn add flutterwave-vue-v3
4646

4747
* Import the Flutterwave Library in the 'main.js' file.
4848

49-
* Add the Flutterwave flutterwave to your app passing in your Flutterwave Public Key (optional)
49+
* Add the Flutterwave plugin to your app passing in your Flutterwave Public Key (optional)
5050

5151
* NB: If Public key is not added you will have to pass in the public_key parameter to the provided payment component button and payment function
5252

0 commit comments

Comments
 (0)