3 ms·
No, I didn't say that. The README should have one -two, at most- simple but representative and complete example. An example that shows actual usage of somethin
by genezeta 1y ago
No, I didn't say that.
The README should have one -two, at most- simple but representative and complete example. An example that shows actual usage of something simple enough to be small. See the examples I suggested above. As a companion to that, you can put that same code in JSFiddle and link to it in the README, but keep both the code and link in the README.
As for the documentation, what I said is that the code shown should always be good code, code where names make sense. You may or may not make the effort of putting full JSFiddle examples into your documentation, but the code that you put in the docs should use meaningful names.
- EGreg 1y agoOkay let's say I create a lot of examples like this https://codepen.io/Qbix-Inc/pen/ogjamBy https://codepen.io/Qbix-Inc/pen/ogjamBy How to best embed them in github? Are they helpful?