Skip to content

Commit cbcde35

Browse files
boradakashboradakash
committed
docs: add version and license badges to all readme files
1 parent 1231e8f commit cbcde35

File tree

43 files changed

+380
-92
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+380
-92
lines changed

‎backend/README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/backend/LICENSE)
2+
13
# DeckDeckGo - Backend
24

35
This project is a backend for [DeckDeckGo].
@@ -9,33 +11,33 @@ It also transmits the information for the live voting when you are interacting w
911
## Table of contents
1012

1113
- [Remote control](#remote-control)
12-
- [Receiver](#receiver)
13-
- [Emitter](#emitter)
14+
- [Receiver](#receiver)
15+
- [Emitter](#emitter)
1416
- [Poll](#poll)
1517
- [Develop](#develop)
1618
- [License](#license)
1719

1820
## Remote control
1921

20-
This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control.
22+
This project is use to connect a presentation with the [DeckDeckGo's Progressive Web App](https://deckdeckgo.app) respectively the remote control.
2123

2224
The projects where the peers are implemented are the following:
2325

2426
### Receiver
2527

2628
The remote control "receiver" which should be included in the presentation:
2729

28-
| Source |
29-
| -------------------------- |
30+
| Source |
31+
| ------------------------------------------------------------------------------------------ |
3032
| [https://github.com/deckgo/deckdeckgo-remote](https://github.com/deckgo/deckdeckgo-remote) |
3133

3234
### Emitter
3335

3436
The remote control "emitter", the Progressive Web App, which lets you present and interact with your presentation:
3537

36-
| Application | Source |
37-
| -------------------------- |:-----------------:|
38-
|[https://deckdeckgo.app](https://deckdeckgo.app)|[https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app)|
38+
| Application | Source |
39+
| ------------------------------------------------ | :----------------------------------------------------------------------------------: |
40+
| [https://deckdeckgo.app](https://deckdeckgo.app) | [https://github.com/deckgo/deckdeckgo-app](https://github.com/deckgo/deckdeckgo-app) |
3941

4042
## Poll
4143

@@ -60,4 +62,4 @@ npm run start
6062

6163
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
6264

63-
[DeckDeckGo]: https://deckdeckgo.com
65+
[deckdeckgo]: https://deckdeckgo.com

‎cli/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/create-deckdeckgo
5+
[npm-badge-url]: https://www.npmjs.com/package/create-deckdeckgo
6+
[npm-license]: https://img.shields.io/npm/l/create-deckdeckgo
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/cli/LICENSE
8+
19
# DeckDeckGo - CLI
210

311
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/
1220

1321
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
1422

15-
[DeckDeckGo]: https://deckdeckgo.com
23+
[deckdeckgo]: https://deckdeckgo.com

‎cloud/README.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![license][agpl-license]][agpl-license-url]
2+
3+
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
4+
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/cloud/GNU-AGPL-3.0
5+
16
# DeckDeckGo - Cloud
27

38
This project is the cloud functions of [DeckDeckGo].

‎docs/README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/deckgo/deckdeckgo/blob/master/docs/LICENSE)
2+
13
# DeckDeckGo - Docs
24

35
This project is the documentation for developer of [DeckDeckGo].
@@ -25,10 +27,10 @@ npm run start
2527

2628
The documentation is written in markdown and the app itself is developed with the [Ionic PWA Toolkit](https://ionicframework.com/pwa/toolkit).
2729

28-
Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX).
29-
30+
Before building the application, the markdown content is going to be parsed to HTML and injected in its source code (TSX).
31+
3032
## License
3133

3234
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
3335

34-
[DeckDeckGo]: https://deckdeckgo.com
36+
[deckdeckgo]: https://deckdeckgo.com

‎infra/LICENSE

-21
This file was deleted.

‎infra/README.md

+10-5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![license][agpl-license]][agpl-license-url]
2+
3+
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
4+
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/GNU-AGPL-3.0
5+
16
# DeckDeckGo - Infrastructure
27

38
This project is the infrastructure of [DeckDeckGo].
@@ -15,7 +20,7 @@ The infrastructure is deployed with [Terraform] and runs on [AWS Lambda].
1520

1621
To (re)deploy the infrastructure, run the following commands:
1722

18-
``` shell
23+
```shell
1924
$ cd infra/
2025
$ nix-shell
2126
$ terraform apply
@@ -32,7 +37,7 @@ This project, respectively the infrastructure of [DeckDeckGo], is released under
3237

3338
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]).
3439

35-
[DeckDeckGo]: https://deckdeckgo.com
36-
[Terraform]: https://www.terraform.io/
37-
[AWS Lambda]: https://aws.amazon.com/lambda/
38-
[Nix]: https://nixos.org/nix/
40+
[deckdeckgo]: https://deckdeckgo.com
41+
[terraform]: https://www.terraform.io/
42+
[aws lambda]: https://aws.amazon.com/lambda/
43+
[nix]: https://nixos.org/nix/

‎infra/handler/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![license][agpl-license]][agpl-license-url]
2+
3+
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
4+
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/infra/handler/GNU-AGPL-3.0
5+
16
# DeckDeckGo - Handler
27

38
This project is the request handler of [DeckDeckGo].
@@ -17,4 +22,4 @@ details.
1722
Busco](mailto:[email protected]) and [Nicolas
1823
Mattia](mailto:[email protected]).
1924

20-
[DeckDeckGo]: https://deckdeckgo.com
25+
[deckdeckgo]: https://deckdeckgo.com

‎remote/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![license][agpl-license]][agpl-license-url]
2+
3+
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
4+
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/remote/GNU-AGPL-3.0
5+
16
# DeckDeckGo - App
27

38
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
1621

1722
1. Open the [DeckDeckGo] website 👉 [https://deckdeckgo.com](https://deckdeckgo.com)
1823
2. Start this Progressive Web App 👉 [https://deckdeckgo.app](https://deckdeckgo.app)
19-
3. Have fun 🎉
24+
3. Have fun 🎉
2025

2126
## Getting Started
2227

@@ -35,4 +40,4 @@ This application, respectively this remote control of [DeckDeckGo], is released
3540

3641
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]).
3742

38-
[DeckDeckGo]: https://deckdeckgo.com
43+
[deckdeckgo]: https://deckdeckgo.com

‎studio/README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
[![license][agpl-license]][agpl-license-url]
2+
3+
[agpl-license]: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
4+
[agpl-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/studio/GNU-AGPL-3.0
5+
16
# DeckDeckGo - Studio
27

38
This project is the editor of [DeckDeckGo].
@@ -17,11 +22,11 @@ cd deckdeckgo/studio
1722
npm install
1823
npm run start
1924
```
20-
25+
2126
## License
2227

2328
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:[email protected]) and [Nicolas Mattia](mailto:[email protected]), Zürich, Switzerland. See COPYING for more details.
2429

2530
[DeckDeckGo] is developed by [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected]).
2631

27-
[DeckDeckGo]: https://deckdeckgo.com
32+
[deckdeckgo]: https://deckdeckgo.com

‎utils/deck/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/deck-utils
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/deck-utils
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/deck-utils
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/deck/LICENSE
8+
19
# DeckDeckGo - Deck utils
210

311
Utils and styles for the [DeckDeckGo] applications.
@@ -22,4 +30,4 @@ npm run build
2230

2331
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
2432

25-
[DeckDeckGo]: https://deckdeckgo.com
33+
[deckdeckgo]: https://deckdeckgo.com

‎utils/remote/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/remote-utils
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/remote-utils
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/remote-utils
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/remote/LICENSE
8+
19
# DeckDeckGo - Remote utils
210

311
Utils for the [DeckDeckGo] remote control.

‎utils/slide/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/slide-utils
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/slide-utils
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/slide-utils
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/slide/LICENSE
8+
19
# DeckDeckGo - Slide utils
210

311
Utils and interfaces for the [DeckDeckGo] slide templates.
@@ -22,4 +30,4 @@ npm run build
2230

2331
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
2432

25-
[DeckDeckGo]: https://deckdeckgo.com
33+
[deckdeckgo]: https://deckdeckgo.com

‎utils/types/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/types-utils
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/types-utils
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/types-utils
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/types/LICENSE
8+
19
# DeckDeckGo - Types
210

311
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
2230

2331
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
2432

25-
[DeckDeckGo]: https://deckdeckgo.com
33+
[deckdeckgo]: https://deckdeckgo.com

‎utils/utils/README.md

+10-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/utils
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/utils
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/utils
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/utils/utils/LICENSE
8+
19
# DeckDeckGo - Types
210

311
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
6169

6270
```
6371
static isFullscreen(): boolean
64-
```
72+
```
6573

6674
## License
6775

6876
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
6977

70-
[DeckDeckGo]: https://deckdeckgo.com
78+
[deckdeckgo]: https://deckdeckgo.com

‎webcomponents/charts/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/charts
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/charts
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/charts
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/charts/LICENSE
8+
19
# DeckDeckGo - Charts
210

311
This component is the charts' plotter of [DeckDeckGo].
@@ -29,4 +37,4 @@ npm run start
2937

3038
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
3139

32-
[DeckDeckGo]: https://deckdeckgo.com
40+
[deckdeckgo]: https://deckdeckgo.com

‎webcomponents/color/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/color
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/color
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/color
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/color/LICENSE
8+
19
# DeckDeckGo - Color Picker
210

311
The "Color Picker" component is a simple component to, guess what, allow your users to "pick colors" 😉
@@ -29,4 +37,4 @@ npm run start
2937

3038
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
3139

32-
[DeckDeckGo]: https://deckdeckgo.com
40+
[deckdeckgo]: https://deckdeckgo.com

‎webcomponents/core/README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/core
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/core
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/core
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/core/LICENSE
8+
19
# DeckDeckGo - Core
210

311
This component is the core of [DeckDeckGo].
@@ -24,4 +32,4 @@ npm run start
2432

2533
MIT © [David Dal Busco](mailto:[email protected]) and [Nicolas Mattia](mailto:[email protected])
2634

27-
[DeckDeckGo]: https://deckdeckgo.com
35+
[deckdeckgo]: https://deckdeckgo.com

‎webcomponents/demo/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/demo
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/demo
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/demo
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/demo/LICENSE
8+
19
# DeckDeckGo - Demo
210

311
A Web Component to display your apps or websites inside an Android or iOS frame

‎webcomponents/drag-resize-rotate/README.md

+8
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
[![npm][npm-badge]][npm-badge-url]
2+
[![license][npm-license]][npm-license-url]
3+
4+
[npm-badge]: https://img.shields.io/npm/v/@deckdeckgo/drag-resize-rotate
5+
[npm-badge-url]: https://www.npmjs.com/package/@deckdeckgo/drag-resize-rotate
6+
[npm-license]: https://img.shields.io/npm/l/@deckdeckgo/drag-resize-rotate
7+
[npm-license-url]: https://github.com/deckgo/deckdeckgo/blob/master/webcomponents/drag-resize-rotate/LICENSE
8+
19
# DeckDeckGo - Draggable, Resizable and Rotatable
210

311
A Web Component to drag, resize and rotate any element.

0 commit comments

Comments
 (0)