From 9b77c32d7c87ac70b541e85e1ed934172c63f1ba Mon Sep 17 00:00:00 2001 From: Iwasaki Yudai Date: Sat, 22 Aug 2015 09:49:55 +0900 Subject: [PATCH] Explain architecture briefly in README Mentioning hterm and wetty so that people don't get confused that GoTTY has an original terminal implementation. --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 54a62fe..c94e1cc 100644 --- a/README.md +++ b/README.md @@ -103,6 +103,10 @@ godep restore make ``` +## Architecture + +Gotty uses [hterm](https://groups.google.com/a/chromium.org/forum/#!forum/chromium-hterm) to run a JavaScript based terminal on web browsers. Gotty itself provides a websocket server that simply relays output from the PTY to clients and receives input from clients and forwards to the PTY. This hterm + websocket idea is highly inspired by [Wetty](https://github.com/krishnasrinivas/wetty). + # License The MIT License