LogosDistort icon indicating copy to clipboard operation
LogosDistort copied to clipboard

Add better documentation

Open Whip opened this issue 10 years ago • 2 comments

Amazing plugin but too bad a novice like me cannot use it. I'm having a lot of trouble trying to understand how to setup the plugin. Please write a better documentation and tutorials. You haven't mentioned once how to fully set up the plugin in steps.

I saw the code in your examples and they are way different from each other and some of the code is not mentioned in the docs, eg the way you're calling the function and using options. And You also never mentioned to include the css file either, I discovered that going through the examples. Please include those as well.

Thanks

Whip avatar Oct 26 '15 14:10 Whip

Ah yea, your right.

Can you give me some perspective as to what's missing (other then the css and perhaps some setup?)

Should I outline each demo in the docs/wiki? Do I need to go through each setting in depth to show the differences, or does implimentation only (demo docs) work better?

I'm thinking that since this is a pretty big can of worms, I should use the wiki pages on github to do further documentation. Would this be alright?

hellsan631 avatar Oct 26 '15 17:10 hellsan631

Well I'm not any expert on this and other authors might give you better advice but I'd like to see a simple tutorial that lays out all the steps that would lead to a working demo. That is, everything you need to do to setup the basic example.

Then you can mention in detail other features and enhancements to improve upon the basic example and add more features.

Hope this helps

Whip avatar Oct 28 '15 08:10 Whip