Must call ripples({}) before using ripples('drop'

sirxemic / jquery.ripples

Add a water ripple effect to your background using WebGL.

https://sirxemic.github.io/jquery.ripples/

MIT License

1.05k stars 415 forks source link

Must call ripples({}) before using ripples('drop' #74

Open salcott opened 3 years ago

salcott commented 3 years ago

Trying to use this library (thank you, by the way, it is beautiful) and didn't realize you have to call ripples() on the target element before trying to call ripples() with the 'drop' method option. This should be added in the docs, used quite a few hours working to figure it out.

sirxemic commented 3 years ago

I don't know what's expected from jQuery plugins these days (I haven't used jQuery in forever), but the readme does say that you initialize the plugin by calling .ripples() or .ripples(options). Did you miss that part or is the phrasing perhaps a bit ambiguous and can it be improved?