@voyage-sdk/core 0.1.0 → 0.1.1
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 +6 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @voyage/
|
|
1
|
+
# @voyage-sdk/core
|
|
2
2
|
|
|
3
3
|
Feedback widget SDK for collecting user feedback. Help your users send feedback directly to the maker.
|
|
4
4
|
|
|
@@ -20,8 +20,7 @@ Or via CDN:
|
|
|
20
20
|
### ES Module
|
|
21
21
|
|
|
22
22
|
```javascript
|
|
23
|
-
import Voyage from '@voyage/
|
|
24
|
-
import '@voyage/sdk/style.css'
|
|
23
|
+
import Voyage from '@voyage-sdk/core'
|
|
25
24
|
|
|
26
25
|
Voyage.init({
|
|
27
26
|
sdkKey: 'your-sdk-key-here'
|
|
@@ -47,18 +46,14 @@ Voyage.init({
|
|
|
47
46
|
// Required: Your SDK key from the dashboard
|
|
48
47
|
sdkKey: 'your-sdk-key-here',
|
|
49
48
|
|
|
50
|
-
// Optional: Override theme settings
|
|
51
|
-
theme: {
|
|
52
|
-
primaryColor: '#7C3AED',
|
|
53
|
-
position: 'bottom-right' // or 'bottom-left'
|
|
54
|
-
},
|
|
55
|
-
|
|
56
49
|
// Optional: Control where the widget appears
|
|
57
50
|
include: ['/dashboard/*', '/app/*'], // Only show on these paths
|
|
58
51
|
exclude: ['/admin/*', '/login'] // Hide on these paths
|
|
59
52
|
})
|
|
60
53
|
```
|
|
61
54
|
|
|
55
|
+
> **Note:** Theme settings (color, position, labels) are configured from the dashboard.
|
|
56
|
+
|
|
62
57
|
## API
|
|
63
58
|
|
|
64
59
|
### `Voyage.init(config)`
|
|
@@ -119,10 +114,10 @@ Voyage.init({
|
|
|
119
114
|
|
|
120
115
|
## Get Your SDK Key
|
|
121
116
|
|
|
122
|
-
1. Sign up at [
|
|
117
|
+
1. Sign up at [morphPRD.io](https://morphPRD.io)
|
|
123
118
|
2. Create a new project
|
|
124
119
|
3. Copy your SDK key from the project settings
|
|
125
120
|
|
|
126
121
|
## License
|
|
127
122
|
|
|
128
|
-
MIT
|
|
123
|
+
MIT
|