Merge pull request #1011 from juanjoDiaz/remove_console_statements

[mirror_novnc.git] / README.md

diff --git a/README.md b/README.md
index 8df267a44efabed4521c759ce1a132b955a33560..23dc5c303eb5a32ec91a404f9188c7aef03aed94 100644 (file)
--- a/README.md
+++ b/README.md
@@ -16,6 +16,17 @@ Many companies, projects and products have integrated noVNC including
 [the Projects and Companies wiki page](https://github.com/novnc/noVNC/wiki/Projects-and-companies-using-noVNC)
 for a more complete list with additional info and links.
 
+### Table of Contents
+
+- [News/help/contact](#newshelpcontact)
+- [Features](#features)
+- [Screenshots](#screenshots)
+- [Browser Requirements](#browser-requirements)
+- [Server Requirements](#server-requirements)
+- [Quick Start](#quick-start)
+- [Integration and Deployment](#integration-and-deployment)
+- [Authors/Contributors](#authorscontributors)
+
 ### News/help/contact
 
 The project website is found at [novnc.com](http://novnc.com).
@@ -53,14 +64,11 @@ Please tweet [@noVNC](http://www.twitter.com/noVNC) if you do.
 
 * Supports all modern browsers including mobile (iOS, Android)
 * Supported VNC encodings: raw, copyrect, rre, hextile, tight, tightPNG
-* WebSocket SSL/TLS encryption (i.e. "wss://") support
-* 24-bit true color and 8 bit colour mapped
-* Supports desktop resize notification/pseudo-encoding
-* Local or remote cursor
+* Supports scaling, clipping and resizing the desktop
+* Local cursor rendering
 * Clipboard copy/paste
-* Clipping or scolling modes for large remote screens
-* Easy site integration and theming (3 example themes included)
-* Licensed under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/)
+* Licensed mainly under the [MPL 2.0](http://www.mozilla.org/MPL/2.0/), see
+  [the license document](LICENSE.txt) for details
 
 ### Screenshots
 
@@ -75,38 +83,45 @@ See more screenshots
 
 ### Browser Requirements
 
-* Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12, etc.
-
-* HTML5 Canvas, WebSockets and Typed Arrays, etc.
-
-* Fast Javascript Engine: this is not strictly a requirement, but without a
-  fast Javascript engine, noVNC might be painfully slow.
+noVNC uses many modern web technologies so a formal requirement list is
+not available. However these are the minimum versions we are currently
+aware of:
 
-* See the more detailed
-[browser compatibility wiki page](https://github.com/novnc/noVNC/wiki/Browser-support).
+* Chrome 49, Firefox 44, Safari 10, Opera 36, IE 11, Edge 12
 
 
 ### Server Requirements
 
-Unless you are using a VNC server with support for WebSockets connections (such
-as [x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
-[QEMU](http://www.qemu.org/), or
-[MobileVNC](http://www.smartlab.at/mobilevnc/)), you need to use a
-WebSockets to TCP socket proxy. There is a python proxy included
-('websockify').
+noVNC follows the standard VNC protocol, but unlike other VNC clients it does
+require WebSockets support. Many servers include support (e.g.
+[x11vnc/libvncserver](http://libvncserver.sourceforge.net/),
+[QEMU](http://www.qemu.org/), and
+[MobileVNC](http://www.smartlab.at/mobilevnc/)), but for the others you need to
+use a WebSockets to TCP socket proxy. noVNC has a sister project
+[websockify](https://github.com/novnc/websockify) that provides a simple such
+proxy.
 
 
 ### Quick Start
 
-* Use the launch script to start a mini-webserver and the WebSockets proxy
-  (websockify). The `--vnc` option is used to specify the location of a running
-  VNC server:
+* Use the launch script to automatically download and start websockify, which
+  includes a mini-webserver and the WebSockets proxy. The `--vnc` option is
+  used to specify the location of a running VNC server:
 
     `./utils/launch.sh --vnc localhost:5901`
 
 * Point your browser to the cut-and-paste URL that is output by the launch
-  script. Enter a password if the VNC server has one configured. Hit the
-  Connect button and enjoy!
+  script. Hit the Connect button, enter a password if the VNC server has one
+  configured, and enjoy!
+
+
+### Integration and Deployment
+
+Please see our other documents for how to integrate noVNC in your own software,
+or deploying the noVNC application in production environments:
+
+* [Embedding](docs/EMBEDDING.md) - For the noVNC application
+* [Library](docs/LIBRARY.md) - For the noVNC JavaScript library
 
 
 ### Authors/Contributors