diff --git a/backend/README.md b/backend/README.md index 5a5f6def8..c1f93ddea 100644 --- a/backend/README.md +++ b/backend/README.md @@ -1,3 +1,5 @@ +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/backend/LICENSE) + # DeckDeckGo - Backend This project is a backend for [DeckDeckGo]. @@ -9,15 +11,15 @@ It also transmits the information for the live voting when you are interacting w ## Table of contents - [Remote control](#remote-control) - - [Receiver](#receiver) - - [Emitter](#emitter) + - [Receiver](#receiver) + - [Emitter](#emitter) - [Poll](#poll) - [Develop](#develop) - [License](#license) ## Remote control -This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control. +This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control. The projects where the peers are implemented are the following: @@ -25,17 +27,17 @@ The projects where the peers are implemented are the following: The remote control "receiver" which should be included in the presentation: -| Source | -| -------------------------- | +| Source | +| ------------------------------------------------------------------------------------------ | | [https://github.com/deckgo/deckdeckgo-remote](https://github.com/deckgo/deckdeckgo-remote) | ### Emitter The remote control "emitter", the Progressive Web App, which lets you present and interact with your presentation: -| Application | Source | -| -------------------------- |:-----------------:| -|[https://deckdeckgo.app](https://deckdeckgo.app)|[https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app)| +| Application | Source | +| ------------------------------------------------ | :----------------------------------------------------------------------------------: | +| [https://deckdeckgo.app](https://deckdeckgo.app) | [https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app) | ## Poll @@ -60,4 +62,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/cli/README.md b/cli/README.md index 5c9a3fdb0..dd450b4d1 100644 --- a/cli/README.md +++ b/cli/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/create-deckdeckgo +[npm-badge-url]: https://www.npmjs.com/package/create-deckdeckgo +[npm-license]: https://img.shields.io/npm/l/create-deckdeckgo +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/cli/LICENSE + # DeckDeckGo - CLI This project is the CLI of [DeckDeckGo]. @@ -12,4 +20,4 @@ This CLI reuse many features of the [Stencil CLI](https://github.com/ionic-team/ MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/cloud/README.md b/cloud/README.md index 0bca57b8a..1583b1ce1 100644 --- a/cloud/README.md +++ b/cloud/README.md @@ -1,3 +1,8 @@ +[![license][agpl-license]][agpl-license-url] + +[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/cloud/GNU-AGPL-3.0 + # DeckDeckGo - Cloud This project is the cloud functions of [DeckDeckGo]. diff --git a/docs/README.md b/docs/README.md index d6d0dbbed..f760b3192 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,3 +1,5 @@ +[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/docs/LICENSE) + # DeckDeckGo - Docs This project is the documentation for developer of [DeckDeckGo]. @@ -25,10 +27,10 @@ npm run start The documentation is written in markdown and the app itself is developed with the [Ionic PWA Toolkit](https://ionicframework.com/pwa/toolkit). -Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX). - +Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX). + ## License MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/infra/LICENSE b/infra/LICENSE deleted file mode 100644 index c0e5d1513..000000000 --- a/infra/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2019 David Dal Busco and Nicolas Mattia - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/infra/README.md b/infra/README.md index 183117046..9732e3836 100644 --- a/infra/README.md +++ b/infra/README.md @@ -1,3 +1,8 @@ +[![license][agpl-license]][agpl-license-url] + +[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/GNU-AGPL-3.0 + # DeckDeckGo - Infrastructure This project is the infrastructure of [DeckDeckGo]. @@ -15,7 +20,7 @@ The infrastructure is deployed with [Terraform] and runs on [AWS Lambda]. To (re)deploy the infrastructure, run the following commands: -``` shell +```shell $ cd infra/ $ nix-shell $ terraform apply @@ -32,7 +37,7 @@ This project, respectively the infrastructure of [DeckDeckGo], is released under [DeckDeckGo] is developed by [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com). -[DeckDeckGo]: https://deckdeckgo.com -[Terraform]: https://www.terraform.io/ -[AWS Lambda]: https://aws.amazon.com/lambda/ -[Nix]: https://nixos.org/nix/ +[deckdeckgo]: https://deckdeckgo.com +[terraform]: https://www.terraform.io/ +[aws lambda]: https://aws.amazon.com/lambda/ +[nix]: https://nixos.org/nix/ diff --git a/infra/handler/README.md b/infra/handler/README.md index 70dce2d16..a577bddea 100644 --- a/infra/handler/README.md +++ b/infra/handler/README.md @@ -1,3 +1,8 @@ +[![license][agpl-license]][agpl-license-url] + +[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/handler/GNU-AGPL-3.0 + # DeckDeckGo - Handler This project is the request handler of [DeckDeckGo]. @@ -17,4 +22,4 @@ details. Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com). -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/remote/README.md b/remote/README.md index ab782bc54..f0862b91f 100644 --- a/remote/README.md +++ b/remote/README.md @@ -1,3 +1,8 @@ +[![license][agpl-license]][agpl-license-url] + +[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/remote/GNU-AGPL-3.0 + # DeckDeckGo - App This project is the remote control of [DeckDeckGo] which let you interact with and present your PWA presentation. @@ -16,7 +21,7 @@ Better than a description, the [DeckDeckGo] website implement a deck and receive 1. Open the [DeckDeckGo] website 👉 [https://deckdeckgo.com](https://deckdeckgo.com) 2. Start this Progressive Web App 👉 [https://deckdeckgo.app](https://deckdeckgo.app) -3. Have fun 🎉 +3. Have fun 🎉 ## Getting Started @@ -35,4 +40,4 @@ This application, respectively this remote control of [DeckDeckGo], is released [DeckDeckGo] is developed by [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com). -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/studio/README.md b/studio/README.md index e2c2f593b..5a37c5dbb 100644 --- a/studio/README.md +++ b/studio/README.md @@ -1,3 +1,8 @@ +[![license][agpl-license]][agpl-license-url] + +[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg +[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/studio/GNU-AGPL-3.0 + # DeckDeckGo - Studio This project is the editor of [DeckDeckGo]. @@ -17,11 +22,11 @@ cd deckdeckgo/studio npm install npm run start ``` - + ## License This application, respectively this editor of [DeckDeckGo] known as "DeckDeckGo Studio", is released under the GNU Affero General Public License. Copyright [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com), Zürich, Switzerland. See COPYING for more details. [DeckDeckGo] is developed by [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com). -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/utils/deck/README.md b/utils/deck/README.md index 49f55ec08..c97f1b556 100644 --- a/utils/deck/README.md +++ b/utils/deck/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/deck-utils +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/deck-utils +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/deck-utils +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/deck/LICENSE + # DeckDeckGo - Deck utils Utils and styles for the [DeckDeckGo] applications. @@ -22,4 +30,4 @@ npm run build MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/utils/remote/README.md b/utils/remote/README.md index c6a21ff79..dec580ccd 100644 --- a/utils/remote/README.md +++ b/utils/remote/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/remote-utils +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/remote-utils +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/remote-utils +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/remote/LICENSE + # DeckDeckGo - Remote utils Utils for the [DeckDeckGo] remote control. diff --git a/utils/slide/README.md b/utils/slide/README.md index b345b3a08..8a52d4e08 100644 --- a/utils/slide/README.md +++ b/utils/slide/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-utils +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-utils +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-utils +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/slide/LICENSE + # DeckDeckGo - Slide utils Utils and interfaces for the [DeckDeckGo] slide templates. @@ -22,4 +30,4 @@ npm run build MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/utils/types/README.md b/utils/types/README.md index 4552b30cc..c309d2c08 100644 --- a/utils/types/README.md +++ b/utils/types/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/types-utils +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/types-utils +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/types-utils +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/types/LICENSE + # DeckDeckGo - Types 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. @@ -22,4 +30,4 @@ npm run build MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/utils/utils/README.md b/utils/utils/README.md index 44a3c5966..a9bb1e9da 100644 --- a/utils/utils/README.md +++ b/utils/utils/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/utils +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/utils +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/utils +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/utils/LICENSE + # DeckDeckGo - Types A collection of utils methods and functions developed and used across apps and components of [DeckDeckGo]. @@ -61,10 +69,10 @@ Compare the `window.innerHeight` and `screen.height` to detect full screen or no ``` static isFullscreen(): boolean -``` +``` ## License MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/charts/README.md b/webcomponents/charts/README.md index 972018d3d..eb038ba5a 100644 --- a/webcomponents/charts/README.md +++ b/webcomponents/charts/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/charts +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/charts +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/charts +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/charts/LICENSE + # DeckDeckGo - Charts This component is the charts' plotter of [DeckDeckGo]. @@ -29,4 +37,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/color/README.md b/webcomponents/color/README.md index e772dd078..18f881382 100644 --- a/webcomponents/color/README.md +++ b/webcomponents/color/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/color +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/color +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/color +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/color/LICENSE + # DeckDeckGo - Color Picker The "Color Picker" component is a simple component to, guess what, allow your users to "pick colors" 😉 @@ -29,4 +37,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/core/README.md b/webcomponents/core/README.md index 25d6aaf9b..96dd2bd17 100644 --- a/webcomponents/core/README.md +++ b/webcomponents/core/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/core +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/core +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/core +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/core/LICENSE + # DeckDeckGo - Core This component is the core of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/demo/README.md b/webcomponents/demo/README.md index d9126903c..e6081a73c 100644 --- a/webcomponents/demo/README.md +++ b/webcomponents/demo/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/demo +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/demo +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/demo +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/demo/LICENSE + # DeckDeckGo - Demo A Web Component to display your apps or websites inside an Android or iOS frame diff --git a/webcomponents/drag-resize-rotate/README.md b/webcomponents/drag-resize-rotate/README.md index f545e1b6c..dd16bf07c 100644 --- a/webcomponents/drag-resize-rotate/README.md +++ b/webcomponents/drag-resize-rotate/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/drag-resize-rotate +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/drag-resize-rotate +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/drag-resize-rotate +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/drag-resize-rotate/LICENSE + # DeckDeckGo - Draggable, Resizable and Rotatable A Web Component to drag, resize and rotate any element. diff --git a/webcomponents/highlight-code/README.md b/webcomponents/highlight-code/README.md index a07e79d8c..235ec8a77 100644 --- a/webcomponents/highlight-code/README.md +++ b/webcomponents/highlight-code/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/highlight-code +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/highlight-code +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/highlight-code +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/highlight-code/LICENSE + # DeckDeckGo - Highlight Code This component is the code highlighter of [DeckDeckGo]. @@ -31,4 +39,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/inline-editor/README.md b/webcomponents/inline-editor/README.md index 01c656528..21a69cfff 100644 --- a/webcomponents/inline-editor/README.md +++ b/webcomponents/inline-editor/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/inline-editor +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/inline-editor +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/inline-editor +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/inline-editor/LICENSE + # DeckDeckGo - WYSIWYG HTML Inline Editor Web Component This Web Component is an inline WYSIWYG HTML Editor developed for the project [DeckDeckGo]. @@ -31,4 +39,4 @@ MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia] The bullet list, link and image icons were both extracted to data uri from the [Ionicons](https://ionicons.com) which is licensed under the MIT license too. -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/lazy-img/README.md b/webcomponents/lazy-img/README.md index dd1dbb6a4..2af51f128 100644 --- a/webcomponents/lazy-img/README.md +++ b/webcomponents/lazy-img/README.md @@ -1,8 +1,16 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/lazy-img +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/lazy-img +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/lazy-img +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/lazy-img/LICENSE + # DeckDeckGo - A dead simple Web Component to lazy load images This Web Component is a dead simple component to lazy load images which was developed for the project [DeckDeckGo]. -It leverages the IntersectionObserver API to lazy load images and also allows you to trigger "manually" their loading. +It leverages the IntersectionObserver API to lazy load images and also allows you to trigger "manually" their loading. ## Table of contents @@ -29,4 +37,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/math/README.md b/webcomponents/math/README.md index c3f933a54..df85412c4 100644 --- a/webcomponents/math/README.md +++ b/webcomponents/math/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/math +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/math +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/math +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/math/LICENSE + # DeckDeckGo - Math A Web Component to write and render math expressions. diff --git a/webcomponents/qrcode/README.md b/webcomponents/qrcode/README.md index 3bac6c8df..a25576595 100644 --- a/webcomponents/qrcode/README.md +++ b/webcomponents/qrcode/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/qrcode +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/qrcode +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/qrcode +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/qrcode/LICENSE + # DeckDeckGo - QR Code This component is the QR code generator of [DeckDeckGo]. @@ -29,4 +37,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/remote/README.md b/webcomponents/remote/README.md index 7dcf23e9b..f0ae53562 100644 --- a/webcomponents/remote/README.md +++ b/webcomponents/remote/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/remote +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/remote +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/remote +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/remote/LICENSE + # DeckDeckGo - Remote This project is a Web Component which act as the remote control receiver of the [Progressive Web App](https://deckdeckgo.app) of [DeckDeckGo] . @@ -6,13 +14,13 @@ This project is a Web Component which act as the remote control receiver of the - [Features](#features) - [Getting Started](#getting-started) - - [Standalone](#standalone) - - [Install from NPM](#install-from-npm) - - [Using from a CDN](#using-from-a-cdn) - - [Framework integration](#framework-integration) + - [Standalone](#standalone) + - [Install from NPM](#install-from-npm) + - [Using from a CDN](#using-from-a-cdn) + - [Framework integration](#framework-integration) - [Usage](#usage) - - [Attributes](#attributes) - - [Methods](#methods) + - [Attributes](#attributes) + - [Methods](#methods) - [License](#license) ## Features @@ -24,7 +32,7 @@ Once added in your project it will add the two following two main features: ## Getting Started -Start you new presentation by following the quick 👉 [Getting Started guide](https://docs.deckdeckgo.com/docs) 👈 +Start you new presentation by following the quick 👉 [Getting Started guide](https://docs.deckdeckgo.com/docs) 👈 ### Standalone @@ -66,15 +74,15 @@ For a more concrete example you could have a look to the [DeckDeckGo Starter-kit The following options should be set using attributes: -| Attribute | Type | Description | -| -------------------------- |:-----------------:|:-----------------:| -| room | string | The room respectively the presentation's name which will be displayed to the user in the app when he/she will search for presentations to connect to | -| socketUrl | string | A socket URI, in case you would implement your own signaling server | -| width | number | The width of the canvas | -| height | number | The height of the canvas | -| length | number | How many slides contains your deck, this is useful to inform the app about it and initialize the length of the canvas | -| slides | string[] | The ordered list of all the tag names of the slides. Useful if you would like to inform the app about which slides are used in your deck. | -| autoConnect | boolean | If you the component to not connect itself on load, set this property to `false` | +| Attribute | Type | Description | +| ----------- | :------: | :--------------------------------------------------------------------------------------------------------------------------------------------------: | +| room | string | The room respectively the presentation's name which will be displayed to the user in the app when he/she will search for presentations to connect to | +| socketUrl | string | A socket URI, in case you would implement your own signaling server | +| width | number | The width of the canvas | +| height | number | The height of the canvas | +| length | number | How many slides contains your deck, this is useful to inform the app about it and initialize the length of the canvas | +| slides | string[] | The ordered list of all the tag names of the slides. Useful if you would like to inform the app about which slides are used in your deck. | +| autoConnect | boolean | If you the component to not connect itself on load, set this property to `false` | ### Methods @@ -186,4 +194,4 @@ await remote.pause(); MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/aspect-ratio/README.md b/webcomponents/slides/aspect-ratio/README.md index 36bc4f489..9712915dd 100644 --- a/webcomponents/slides/aspect-ratio/README.md +++ b/webcomponents/slides/aspect-ratio/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-aspect-ratio +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-aspect-ratio +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-aspect-ratio +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slide-aspect-ratio/LICENSE + # DeckDeckGo - Slide "Aspect Ratio" This component is the slide/template "Aspect Ratio" of [DeckDeckGo]. diff --git a/webcomponents/slides/author/README.md b/webcomponents/slides/author/README.md index 8ca519430..8ef5bc017 100644 --- a/webcomponents/slides/author/README.md +++ b/webcomponents/slides/author/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-author +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-author +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-author +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/author/LICENSE + # DeckDeckGo - Slide "Author" This component is the slide/template "Author" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/big-img/README.md b/webcomponents/slides/big-img/README.md index 87908867c..207e95a93 100644 --- a/webcomponents/slides/big-img/README.md +++ b/webcomponents/slides/big-img/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-big-img +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-big-img +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-big-img +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/big-img/LICENSE + # DeckDeckGo - Slide "Big Image" This component is the slide/template "Big Image" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/chart/README.md b/webcomponents/slides/chart/README.md index a51650566..3dcaf00ee 100644 --- a/webcomponents/slides/chart/README.md +++ b/webcomponents/slides/chart/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-chart +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-chart +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-chart +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/chart/LICENSE + # DeckDeckGo - Slide "Chart" This component is the slide/template "Chart" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/code/README.md b/webcomponents/slides/code/README.md index e7f22306d..3008d70b1 100644 --- a/webcomponents/slides/code/README.md +++ b/webcomponents/slides/code/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-code +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-code +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-code +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/code/LICENSE + # DeckDeckGo - Slide "Code" This component is the slide/template "Code" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/content/README.md b/webcomponents/slides/content/README.md index 36acde070..ed6001fd8 100644 --- a/webcomponents/slides/content/README.md +++ b/webcomponents/slides/content/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-content +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-content +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-content +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/content/LICENSE + # DeckDeckGo - Slide "Content" This component is the slide/template "Content" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/countdown/README.md b/webcomponents/slides/countdown/README.md index a65e07123..3d8ed244a 100644 --- a/webcomponents/slides/countdown/README.md +++ b/webcomponents/slides/countdown/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-countdown +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-countdown +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-countdown +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/countdown/LICENSE + # DeckDeckGo - Slide "Countdown" This component is the slide/template "Countdown" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/gif/README.md b/webcomponents/slides/gif/README.md index a4b2fadef..93fdac7de 100644 --- a/webcomponents/slides/gif/README.md +++ b/webcomponents/slides/gif/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-gif +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-gif +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-gif +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/gif/LICENSE + # DeckDeckGo - Slide "Gif" This component is the slide/template "Gif" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/playground/README.md b/webcomponents/slides/playground/README.md index e630f8cb2..fd6d220c3 100644 --- a/webcomponents/slides/playground/README.md +++ b/webcomponents/slides/playground/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-playground +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-playground +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-playground +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/playground/LICENSE + # DeckDeckGo - Slide "Playground" This component is the slide/template "Playground" of [DeckDeckGo]. diff --git a/webcomponents/slides/poll/README.md b/webcomponents/slides/poll/README.md index 086c99b23..23a80c787 100644 --- a/webcomponents/slides/poll/README.md +++ b/webcomponents/slides/poll/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-poll +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-poll +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-poll +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/poll/LICENSE + # DeckDeckGo - Slide "Poll" This component is the slide/template "Poll" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/qrcode/README.md b/webcomponents/slides/qrcode/README.md index f590a6160..cda1a0166 100644 --- a/webcomponents/slides/qrcode/README.md +++ b/webcomponents/slides/qrcode/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-qrcode +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-qrcode +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-qrcode +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/qrcode/LICENSE + # DeckDeckGo - Slide "QR Code" This component is the slide/template "QR Code" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/split/README.md b/webcomponents/slides/split/README.md index 6bd1f7e7c..0b28fcd71 100644 --- a/webcomponents/slides/split/README.md +++ b/webcomponents/slides/split/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-split +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-split +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-split +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/split/LICENSE + # DeckDeckGo - Slide "Split" This component is the slide/template "Split" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/title/README.md b/webcomponents/slides/title/README.md index 80f441a07..bb6e6d87f 100644 --- a/webcomponents/slides/title/README.md +++ b/webcomponents/slides/title/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-title +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-title +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-title +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/title/LICENSE + # DeckDeckGo - Slide "Title" This component is the slide/template "Title" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/video/README.md b/webcomponents/slides/video/README.md index a3884762f..820a56325 100644 --- a/webcomponents/slides/video/README.md +++ b/webcomponents/slides/video/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-video +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-video +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-video +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/video/LICENSE + # DeckDeckGo - Slide Video This component is the slide/template "Video" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com), [Nicolas Mattia](mailto:nicolas@nmattia.com) & [Noël Macé](mailto:contact@noelmace.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/slides/youtube/README.md b/webcomponents/slides/youtube/README.md index ebdea8dc0..1c77d541c 100644 --- a/webcomponents/slides/youtube/README.md +++ b/webcomponents/slides/youtube/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-youtube +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-youtube +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-youtube +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/slides/youtube/LICENSE + # DeckDeckGo - Slide "Youtube" This component is the slide/template "Youtube" of [DeckDeckGo]. @@ -24,4 +32,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/social/README.md b/webcomponents/social/README.md index f8466ed76..1a6108a1d 100644 --- a/webcomponents/social/README.md +++ b/webcomponents/social/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/social +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/social +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/social +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/social/LICENSE + # DeckDeckGo - Color Social A Web Component to generate social link to your Twitter, Dev, Medium, LinkedIn, GitHub accounts or a custom uri. @@ -27,4 +35,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webcomponents/youtube/README.md b/webcomponents/youtube/README.md index 0611ecd28..8d41b73d8 100644 --- a/webcomponents/youtube/README.md +++ b/webcomponents/youtube/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/youtube +[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/youtube +[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/youtube +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/youtube/LICENSE + # DeckDeckGo - Youtube A Youtube Web Component player. @@ -29,4 +37,4 @@ npm run start MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com diff --git a/webpack/README.md b/webpack/README.md index fd2d50d22..3bf2ba710 100644 --- a/webpack/README.md +++ b/webpack/README.md @@ -1,3 +1,11 @@ +[![npm][npm-badge]][npm-badge-url] +[![license][npm-license]][npm-license-url] + +[npm-badge]: https://img.shields.io/npm/v/deckdeckgo-webpack-plugins +[npm-badge-url]: https://www.npmjs.com/package/deckdeckgo-webpack-plugins +[npm-license]: https://img.shields.io/npm/l/deckdeckgo-webpack-plugins +[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webpack/LICENSE + # DeckDeckGo - Webpack Plugins This project is a collection of custom Webpack plugins used to build a [DeckDeckGo] presentation. @@ -25,8 +33,8 @@ This Webpack plugin is a simple plugin which has for goal to display some inform ## Webpack Notes Plugin -This Webpack plugin has for goal to remove your notes from your presentation, notably useful when you will run a production build before publishing your presentation online. - +This Webpack plugin has for goal to remove your notes from your presentation, notably useful when you will run a production build before publishing your presentation online. + ## Getting Started If you would like to install and compile locally this project, proceed as following: @@ -42,4 +50,4 @@ npm run build MIT © [David Dal Busco](mailto:david.dalbusco@outlook.com) and [Nicolas Mattia](mailto:nicolas@nmattia.com) -[DeckDeckGo]: https://deckdeckgo.com +[deckdeckgo]: https://deckdeckgo.com