presenter 0.2.2 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -3
- package/dist/webpack.config.d.ts +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -6,17 +6,35 @@ This library is still in development and its API may change at any time.
|
|
|
6
6
|
|
|
7
7
|
## Getting Started
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### Quick Start
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
The simplest way to get started with a Presenter.js presentation is via
|
|
12
|
+
`npm create presenter`.
|
|
12
13
|
|
|
14
|
+
```bash
|
|
15
|
+
$ npm create presenter
|
|
13
16
|
```
|
|
17
|
+
|
|
18
|
+
Running `npm create presenter` will prompt you to enter a project name and will
|
|
19
|
+
then create a new presentation with Presenter.js, written in TypeScript and
|
|
20
|
+
built with Webpack.
|
|
21
|
+
|
|
22
|
+
After creating the new presentation, `cd` into the directory and run
|
|
23
|
+
`npm run serve` to run the presentation. Edit `src/index.ts` to make changes
|
|
24
|
+
to your presentation.
|
|
25
|
+
|
|
26
|
+
### Installing Presenter.js Manually
|
|
27
|
+
|
|
28
|
+
Presenter.js can also be installed manually via `npm`.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
14
31
|
$ npm install presenter
|
|
15
32
|
```
|
|
16
33
|
|
|
17
34
|
### Sample Usage
|
|
18
35
|
|
|
19
|
-
Create a presentation by specifying a list of slides, where each slide may
|
|
36
|
+
Create a presentation by specifying a list of slides, where each slide may
|
|
37
|
+
contain objects and animations.
|
|
20
38
|
|
|
21
39
|
```javascript
|
|
22
40
|
import { Presentation, Slide, Text } from "presenter";
|
package/dist/webpack.config.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "presenter",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.3",
|
|
4
4
|
"description": "A JavaScript presentation library",
|
|
5
5
|
"main": "dist/presenter.js",
|
|
6
6
|
"types": "dist/src/index.d.ts",
|
|
@@ -19,6 +19,7 @@
|
|
|
19
19
|
"url": "https://github.com/brianyu28/presenter/issues"
|
|
20
20
|
},
|
|
21
21
|
"homepage": "https://github.com/brianyu28/presenter#readme",
|
|
22
|
+
"license": "GPL-3.0-or-later",
|
|
22
23
|
"files": [
|
|
23
24
|
"./dist/"
|
|
24
25
|
],
|