/webcomponents/qrcode/README.md

https://github.com/deckgo/deckdeckgo · Markdown · 32 lines · 20 code · 12 blank · 0 comment · 0 complexity · 405ef182336381c0811d003606b8de66 MD5 · raw file 

    

  1. # DeckDeckGo - QR Code
    2. 

  2. 

  3. This component is the QR code generator of [DeckDeckGo].
    4. 

  4. 

  5. It is developed with [Stencil](https://stenciljs.com) and use the project [qrcode-generator](https://github.com/kazuhikoarase/qrcode-generator) from [Kazuhiko Arase](https://github.com/kazuhikoarase) to generate the QR codes.
    6. 

  6. 

  7. ## Table of contents
    8. 

  8. 

  9. - [Getting Started](#getting-started)
    10. 

  10. - [Develop](#develop)
    11. 

  11. - [License](#license)
    12. 

  12. 

  13. ## Getting Started
    14. 

  14. 

  15. To get started with this Web Component, have a look to its [documentation](https://docs.deckdeckgo.com/components/qrcode).
    16. 

  16. 

  17. ## Develop
    18. 

  18. 

  19. To develop and run this Web Component locally, proceed as following:
    20. 

  20. 

  21. ```
    22. 

  22. git clone https://github.com/deckgo/deckdeckgo
    23. 

  23. cd deckdeckgo/webcomponents/qrcode
    24. 

  24. npm install
    25. 

  25. npm run start
    26. 

  26. ```
    27. 

  27. 

  28. ## License
    29. 

  29. 

  30. MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com)
    31. 

  31. 

  32. [DeckDeckGo]: https://deckdeckgo.com
    33.