Skip to content

Commit 5898b24

Browse files
committed
Update readme
1 parent d30e827 commit 5898b24

File tree

1 file changed

+23
-34
lines changed

1 file changed

+23
-34
lines changed

README.md

Lines changed: 23 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -8,23 +8,25 @@ A [demo](https://presentations.jowisoftware.de/demo/) is available here.
88

99
### Server side
1010

11-
Initially, install all required dependencies:
11+
Initially, install all required dependencies and package the application:
1212

1313
```sh
14-
npm install
14+
npm ci
15+
npx gulp
1516
```
1617

1718
To run the server, start:
1819

1920
```sh
20-
node index
21+
node dist/index
2122
```
2223

2324
The default port is 8080. Append "--help" for more information.
2425

2526
### Client side
2627

27-
First, include the dependencies. On Reveal.js 4x. use the following code:
28+
First, include the dependencies.
29+
This plugin requires Reveal.js 4+.
2830

2931
```html
3032
<!--
@@ -34,10 +36,20 @@ First, include the dependencies. On Reveal.js 4x. use the following code:
3436
give the full servername here, e.g.
3537
3638
https://presentations.jowisoftware.de/soket.io/socket.io.js and
37-
https://presentations.jowisoftware.de/_remote/plugin.js_
39+
https://presentations.jowisoftware.de/_remote/plugin/plugin.js_
3840
-->
39-
<script src="../socket.io/socket.io.js"></script>
40-
<script src="../_remote/plugin.js"></script>
41+
42+
<!-- Common.js -->
43+
<script src="/socket.io/socket.io.min.js"></script>
44+
<script src="/_remote/plugin/remote.js"></script>
45+
46+
<!-- alternative: ESM -->
47+
<script type="module">
48+
import Reveal from './dist/reveal.esm.js';
49+
import RevealRemote from '/_remote/plugin/remote.esm.js';
50+
51+
// Reveal setup goes here…
52+
</script>
4153
```
4254

4355
Next, load the plugin as usual:
@@ -49,32 +61,7 @@ Next, load the plugin as usual:
4961
//
5062
});
5163
```
52-
53-
On Reveal.js v 3.x, include the scripts as dependencies instead:
54-
55-
```javascript
56-
Reveal.initialize({
57-
//
58-
dependencies: [
59-
//
60-
61-
/*
62-
reveal.js-remote:
63-
The next two dependencies are required!
64-
If you do not serve the presentations from the presentations/-folder
65-
give the full servername here, e.g.
66-
67-
https://presentations.jowisoftware.de/soket.io/socket.io.js and
68-
https://presentations.jowisoftware.de/_remote/plugin.js_
69-
*/
70-
{ src: '../socket.io/socket.io.js', async: true },
71-
{ src: '../_remote/plugin.js', async: true },
72-
]
73-
//
74-
});
75-
```
76-
77-
In both versions, include the following code block into your presentation's configuration to fine-tune the plugin:
64+
Include the following code block into your presentation's configuration to fine-tune the plugin:
7865

7966
```javascript
8067
Reveal.initialize({
@@ -106,7 +93,7 @@ In both versions, include the following code block into your presentation's conf
10693
});
10794
```
10895

109-
While presenting, press `r` („Remote“) and scan the QR-Code to get the remote control or press `a` („shAre“) to share the presentation.
96+
While presenting, press `r` („**R**emote“) and scan the QR-Code to get the remote control or press `a` („sh**A**re“ or „**A**udience“) to share the presentation.
11097

11198
### Zooming in presentations
11299

@@ -115,6 +102,8 @@ Reveal's zoom-Plugin does not emit any events. This is why changes cannot be tra
115102
However, thanks to [l-jonas](https://github.com/l-jonas) this plugin now ships with a custom zoom functionality.
116103
To enable this plugin, include an additional Javascript:
117104

105+
Common.js:
106+
118107
```html
119108
<script src="../socket.io/socket.io.js"></script>
120109
<script src="../_remote/plugin.js"></script>

0 commit comments

Comments
 (0)