/utils/types/README.md

https://github.com/deckgo/deckdeckgo · Markdown · 25 lines · 16 code · 9 blank · 0 comment · 0 complexity · 7e9af407111ee834e1432968fe31a521 MD5 · raw file 

    

  1. # DeckDeckGo - Types
    2. 

  2. 

  3. This project defines the events, interfaces and enumerations used for the [WebRTC](https://webrtc.org) real-time communication between the [DeckDeckGo]'s deck and remote control.
    4. 

  4. 

  5. ## Table of contents
    6. 

  6. 

  7. - [Getting Started](#getting-started)
    8. 

  8. - [License](#license)
    9. 

  9. 

  10. ## Getting Started
    11. 

  11. 

  12. If you would like to install and compile locally this project, proceed as following:
    13. 

  13. 

  14. ```
    15. 

  15. git clone https://github.com/deckgo/deckdeckgo
    16. 

  16. cd deckdeckgo/utils/types
    17. 

  17. npm install
    18. 

  18. npm run build
    19. 

  19. ```
    20. 

  20. 

  21. ## License
    22. 

  22. 

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

  24. 

  25. [DeckDeckGo]: https://deckdeckgo.com
    26.