@mxenabled/connect-widget 1.2.8 → 2.1.0
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.
- package/README.md +7 -2
- package/dist/index.es.js +1363 -461
- package/dist/index.es.js.map +1 -1
- package/dist/lastBuild.txt +1 -1
- package/dist/style.css +5 -0
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -15,8 +15,9 @@ npm install @mxenabled/connect-widget
|
|
|
15
15
|
## Usage
|
|
16
16
|
|
|
17
17
|
1. Install package: `npm install --save @mxenabled/connect-widget`
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
1. Import the styles `import "@mxenabled/connect-widget/dist/style.css"`
|
|
19
|
+
1. Import `ApiProvider` and `ConnectWidget`. Add both to your project.
|
|
20
|
+
1. Pass applicable props to widget and your API to the provider.
|
|
20
21
|
|
|
21
22
|
```jsx
|
|
22
23
|
import ConnectWidget, { ApiProvider } from '@mxenabled/connect-widget'
|
|
@@ -96,6 +97,10 @@ Pull requests are welcome. Please open an issue first to discuss what you would
|
|
|
96
97
|
|
|
97
98
|
Make sure to add/update tests, translations, and documentation as appropriate.
|
|
98
99
|
|
|
100
|
+
### Architecture Decision Records
|
|
101
|
+
|
|
102
|
+
We have some [architecture decision records](./architectureDecisionRecords/) that outline what is expected when contributing.
|
|
103
|
+
|
|
99
104
|
## Changes
|
|
100
105
|
|
|
101
106
|
View our notes for each release [here](https://github.com/mxenabled/connect-widget/releases)
|