Skip to content

Commit 3519a9a

Browse files
committed
README update
1 parent d6b97d1 commit 3519a9a

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.markdown

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,26 @@ Building the dist version of the project is as easy as running `npm run build`
1515

1616
If you want to deploy the slideshow to surge, run `npm run deploy`
1717

18+
## Presenting
19+
20+
Spectacle comes with a built in presenter mode. It shows you a slide lookahead, current time and your current slide:
21+
22+
![http://i.imgur.com/csPXbjM.png](http://i.imgur.com/csPXbjM.png)
23+
24+
To present:
25+
26+
- Run `npm start`
27+
- Open two browser windows on two different screens
28+
- On your screen visit [http://localhost:3000/#/?presenter](http://localhost:3000/#/)
29+
- On the presentation screen visit [http://localhost:3000/#/](http://localhost:3000/#/)
30+
- Give an amazingly stylish presentation
31+
32+
_Note: Any windows/tabs in the same browser that are running Spectacle will sync to one another, even if you don't want to use presentation mode_
33+
34+
Check it out:
35+
36+
![http://i.imgur.com/H7o2qHI.gif](http://i.imgur.com/H7o2qHI.gif_)
37+
1838
## PDF Export
1939

2040
Exporting a totally sweet looking PDF from your totally sweet looking Spectacle presentation is asburdly easy.
@@ -157,7 +177,7 @@ The deck tag is the top level tag and there should only be one of them. It suppo
157177
158178
|Name|PropType|Description|
159179
|---|---|---|
160-
|transition|React.PropTypes.array|Accepts `slide`, `zoom`, `fade` or `spin`, and can be combined. Sets global slide transitions.|
180+
|transition|React.PropTypes.array|Accepts `slide`, `zoom`, `fade` or `spin`, and can be combined. Sets global slide transitions. **Note: If you use the 'scale' transition, fitted text won't work in Safari.**|
161181
|transitionDuration| React.PropTypes.number| Accepts integer value in milliseconds for global transition duration.
162182
163183
####\<Slide /> (Base)
@@ -167,7 +187,7 @@ The slide tag represents each slide in the presentation. It supports the followi
167187
|Name|PropType|Description|
168188
|---|---|---|
169189
|align| React.PropTypes.string | Accepts a space delimited value for positioning interior content. The first value can be `flex-start` (left), `center` (middle), or `flex-end` (bottom). The second value can be `flex-start` (top) , `center` (middle), or `flex-end` (bottom). You would provide this prop like `align="center middle"`, which is it's default.
170-
|transition|React.PropTypes.array|Accepts `slide`, `zoom`, `fade` or `spin`, and can be combined. Sets the slide transition.|
190+
|transition|React.PropTypes.array|Accepts `slide`, `zoom`, `fade` or `spin`, and can be combined. Sets the slide transition. **Note: If you use the 'scale' transition, fitted text won't work in Safari.**|
171191
|transitionDuration| React.PropTypes.number| Accepts integer value in milliseconds for slide transition duration.
172192
173193
###Layout Tags
@@ -224,7 +244,7 @@ Heading tags are special in that, when you specify a `size` prop, they generate
224244
225245
|Name|PropType|Description|
226246
|---|---|---|
227-
|fit|React.PropTypes.boolean| When set to true, fits text to the slide's width |
247+
|fit|React.PropTypes.boolean| When set to true, fits text to the slide's width. **Note: If you use the 'scale' transition, this won't work in Safari.** |
228248
229249
####\<Image /> (Base)
230250
@@ -270,7 +290,7 @@ The `Text` tag is used to add text to your slide.
270290
271291
|Name|PropType|Description|
272292
|---|---|---|
273-
|fit|React.PropTypes.boolean| When set to true, fits text to the slide's width |
293+
|fit|React.PropTypes.boolean| When set to true, fits text to the slide's width. **Note: If you use the 'scale' transition, this won't work in Safari.** |
274294
275295
### Base Props
276296

0 commit comments

Comments
 (0)