Skip to content

Commit 2e7f9e3

Browse files
Revise features list in README.md
Updated features section for clarity and consistency.
1 parent bf23911 commit 2e7f9e3

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,17 @@ This allows you to easily demonstrate commands without having to open a terminal
1313
This application lends itself to a presentation method similar to the [Takahashi method](https://en.wikipedia.org/wiki/Takahashi_method) where you have a concise slides with very little text. The created presentations are more complex than the Taskahashi method but it is still purposefully designed to keep things simple by only having one type of content per slide, be that text, a command output, or something else.
1414

1515
The result is that with this application backend demos should be much easier to create and run whilst also being slightly more engaging.
16-
Features
16+
17+
## Features
1718

1819
* A presentation is just a simple text file.
19-
* A slide can contain: text, an executed command, a code block, or an image. The syntax uses markdown.
20+
* A slide can contain: text, an executed command, code blocks, or images. The syntax uses markdown.
2021
* Executed commands will stream output to be shown in the slide thanks to [xterm.js](http://xtermjs.org/).
2122
* The command that is executed is shown above the command output.
22-
* Shell commands can be executed before the presentation runs allowing for setup before a presentation.
23+
* Shell commands can be executed before each slide for setup. They can be hidden or not hidden.
2324
* Code blocks are automatically highlighted using [highlight.js](https://highlightjs.org/).
24-
* Embed HTML meaning you can include videos or iframes etc.
25-
* Left click or right arrow to go forwards, right click or left arrow to go backwards.
25+
* HTML can be embedded meaning you can include videos or iframes etc.
26+
* Right arrow to go forwards, left arrow to go backwards.
2627
* Easy to use and share via screen sharing.
2728
* Styling done via CSS meaning it can be easily reconfigured.
2829
* Jump to any slide via a drop down menu.

0 commit comments

Comments
 (0)