mrtoth
/
frontend-tutorial-framework
mirror of https://github.com/avatao-content/frontend-tutorial-framework
1
0
Fork 0
Code Issues Releases Wiki Activity

Add final touches to docs

This commit is contained in:
Kristóf Tóth 2018-04-25 15:06:44 +02:00
parent 38acbac25b
commit e9096b11aa
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -17,7 +17,7 @@ In this section we are going to explore the various pre-made components this pro
Generally these components connect to a TFW event handler running on the backend.
Communication is handled via simpe APIs exposed by these event handlers – over TFW messages.
These APIs are documented in the `baseimage-tutorial-framework` repository as docstrings in the [lib/tfw/components](https://github.com/avatao-content/baseimage-tutorial-framework/tree/master/lib/tfw/components) directory (this is where the event handler implementations live).
These APIs are documented in the `baseimage-tutorial-framework` repository as docstrings in the [lib/tfw/components](https://github.com/avatao-content/baseimage-tutorial-framework/tree/master/lib/tfw/components) directory (this is where the implementations of our pre-written event handlers live).
## Configuration
@ -34,8 +34,10 @@ The emulator is connected to a `TerminalEventHandler` instance on the backend ov
This event handler spawns a `bash` session and a `pty` (pseudoterminal).
It connects the master end of the `pty` to the emulator running in the browser and the slave end to `bash`.
This essentially provides a fully functional terminal session in the browser.
You can write to it (and thus execute commands) and read what commands were executed in `bash` using the API exposed by the `TerminalEventHandler` instance.
This essentially provides a fully functional terminal session for your users in the browser (a convenient alternative for an SSH session).
This terminal is fully under your control:
You can write to it (and thus execute commands) and read what commands were executed by the user using the API exposed by the `TerminalEventHandler` instance.
This enables you to pre-type or execute commands for the user and figure out what they are doing in the terminal.