From a0aa73795f72d2f7ca04fffa5a73f384cb753503 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=B6ren=20Weber?= Date: Tue, 19 May 2020 19:36:16 +0200 Subject: [PATCH] Docs update for reveal 4.x --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8bea78d..f847dc7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AltMode -A [reveal.js](https://github.com/hakimel/reveal.js/) plugin to switch between multiple alternative configuartion presets by pressing a shortcut key. +A [reveal.js](https://github.com/hakimel/reveal.js/) 3.x / 4.x plugin to switch between multiple alternative configuartion presets by pressing a shortcut key. @@ -18,9 +18,25 @@ To change themes in presets the [ThemeOverride](https://github.com/McShelby/reve ## Installation -Copy this repository into the plugins folder of your reveal.js presentation, ie ```plugin/altmode```. +Copy this repository into the plugin folder of your reveal.js presentation, ie ```plugin/altmode```. -Add the plugin to the dependencies in your presentation, as below. +Add the plugin to the initialization of your presentation, as below. + +### reveal 4.x + +```javascript + +// .. +Reveal.initialize({ + // ... + plugins: [ + // .. + AltMode, + ] +}); +``` + +### reveal 3.x ```javascript Reveal.initialize({