OneSignal / onesignal-vue

Vue OneSignal Plugin: Make it easy to integrate OneSignal with your Vue App!
Other
13 stars 2 forks source link

[Feedback]: README has incomplete information for configuring server worker #42

Open bmulholland opened 1 year ago

bmulholland commented 1 year ago

What's on your mind?

Under Init Options, only serviceWorkerParam and serviceWorkerPath are mentioned, not path. But the init source code actually requires path for these to work! The instructions should clearly talk about all the params, which are required, and why.

Also, the instructions aren't clear about how to use those params -- is the serviceWorkerPath relative to the directory in the serviceWorkerParam scope? Absolute? Should the serviceWorkerPath include the name of the JS file? And with the addition of path, how does that connect with the other? What's the intended difference between path and serviceWorkerPath?