search

neocotic / qrious

Pure JavaScript library for QR code generation using canvas
https://neocotic.com/qrious
Other
1.55k stars 216 forks source link

Add live demo link to README #89

Closed neocotic closed 7 years ago

neocotic commented 7 years ago

Currently, a live demo is only available by checking out the code and opening the demo.html file locally or on my homepage (i.e. https://neocotic.com/qrious), which I'm hoping to decommission and replace (see #88).

I feel it would be much more useful to developers if we had a link to live demo in README.md itself. It could be hosted on CodePen. I don't think GitHub allow embedded content within READMEs, so a link to such a thing would suffice, so long as it's given emphasis.

demo.html will continue to exist as it serves as a useful tool for local development.

neocotic commented 7 years ago

Although I'm hoping to move away from RawGit to something like cdnjs for CDN links, I think it would be fine to reference the master file via RawGit within the external demo. This will ease the release process as the demo will only have to be updated to fix breaking changes to the API or to highlight new features.

The demo itself could even be embedded on the new homepage (see #88).

neocotic commented 7 years ago

I've created the following pen for now which we could link to:

https://codepen.io/neocotic/pen/YQzmBm

It's currently a simple copy of demo.html. Fortunately, this approach would allow us to make changes to it without requiring a release.

neocotic commented 7 years ago

I plan on adding a link to the demo within the README using a custom badge. For example:

Demo