@spot-flow/checkout-inline-js 0.0.2 → 0.0.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +33 -2
  2. package/package.json +4 -4
package/README.md CHANGED
@@ -14,7 +14,7 @@ This project is an inline library that enables users to make payments seamlessly
14
14
 
15
15
  ## Usage
16
16
  ```sh
17
- import { CheckoutForm } from @spotflow/inline-js-checkout;
17
+ import { CheckoutForm } from "@spot-flow/checkout-inline-js";
18
18
 
19
19
  const checkout = new CheckoutForm(
20
20
  merchantKey = "<sk_test_f998479c0eedhXXXXXXXXXXXXXXXX>"// This is your Merchant Key generated for your Merchant on Spotflow
@@ -26,7 +26,7 @@ This project is an inline library that enables users to make payments seamlessly
26
26
 
27
27
  Alternatively, you can include it directly in your HTML via a CDN:
28
28
  ```sh
29
- <script src="spotflow/cdn"></script>
29
+ <script src="https://dr4h9151gox1m.cloudfront.net/dist/checkout-inline.js"></script>
30
30
  ```
31
31
 
32
32
  ```sh
@@ -49,4 +49,35 @@ Alternatively, you can include it directly in your HTML via a CDN:
49
49
  ```
50
50
 
51
51
 
52
+ ## Contributing
52
53
 
54
+ We welcome contributions! Follow the steps below to get started:
55
+
56
+ ### Getting Started
57
+
58
+ 1. **Clone the repository:**
59
+
60
+ ```sh
61
+ git clone https://github.com/Spotflow-One/spotflow-checkout.git
62
+ cd your-repo
63
+ ```
64
+
65
+ 2. **Install dependencies:**
66
+
67
+ ```sh
68
+ npm install
69
+ ```
70
+
71
+ ### Example Usage
72
+
73
+ You can see an example of how to use the library in `index.html`. Open this file in your browser to see it in action.
74
+
75
+ ### Building the Project
76
+
77
+ To build the project, run:
78
+
79
+ ```sh
80
+ npm run build
81
+ ```
82
+
83
+ This will compile the source files and generate the output in the `dist` directory.
package/package.json CHANGED
@@ -1,9 +1,9 @@
1
1
  {
2
2
  "name": "@spot-flow/checkout-inline-js",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "",
5
- "main": "/dist/checkout-inline.js",
6
- "source": "/src/index.ts",
5
+ "main": "dist/checkout-inline.js",
6
+ "source": "src/index.ts",
7
7
  "scripts": {
8
8
  "test": "echo \"Error: no test specified\" && exit 1",
9
9
  "dev": "vite",
@@ -11,7 +11,7 @@
11
11
  },
12
12
  "type": "module",
13
13
  "keywords": [],
14
- "types": "/dist/index.d.ts",
14
+ "types": "dist/index.d.ts",
15
15
  "files": [
16
16
  "dist"
17
17
  ],