Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit bf98b61

Browse files
doc: update with the new CLI
1 parent 3343332 commit bf98b61

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Create a lightweight presentation using HTML and Web Components.
1010
- [Table of contents](#table-of-contents)
1111
- [Features](#features)
1212
- [Starter kit extra features](#starter-kit-extra-features)
13-
- [Getting Started](#getting-started)
13+
- [Getting Started](#getting-started)
14+
- [Installing DeckDeckGo in any projects](#installing-deckdeckgo-in-any-projects)
1415
- [Using DeckDeckGo from a CDN](#using-deckdeckgo-from-a-cdn)
1516
- [Install DeckDeckGo from npm](#install-deckdeckgo-from-npm)
1617
- [Framework integration](#framework-integration)
@@ -47,11 +48,19 @@ Create a lightweight presentation using HTML and Web Components.
4748

4849
* 🦄 Use **Ionic** components and icons to create the content or even add extra features
4950

50-
*Note: [DeckDeckGo] will soon offer a CLI to let you initialize your presentation based on the starter kit more easily*
51-
5251
## Getting Started
5352

54-
Use [DeckDeckGo] directly in your project from a CDN using a simple script include or install it from [npm](https://www.npmjs.com/package/deckdeckgo)
53+
[DeckDeckGo] provides a [CLI](https://github.com/fluster/create-deckdeckgo) and a [starter kit](https://github.com/fluster/deckdeckgo-starter).
54+
55+
To get started and to create your presentation, simply run the following command and follow the prompt:
56+
57+
```bash
58+
npm init deckdeckgo
59+
```
60+
61+
## Installing DeckDeckGo in any projects
62+
63+
If you wish to use the [DeckDeckGo] presentation tool without any tooling, use it directly in your project from a CDN using a simple script include or install it from [npm](https://www.npmjs.com/package/deckdeckgo).
5564

5665
### Using DeckDeckGo from a CDN
5766

0 commit comments

Comments
 (0)