diff --git a/docs/conf.py b/docs/conf.py index 8186ce8b..00a9801c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -51,9 +51,9 @@ copyright = u'2014, sourceLair Limited' # built documents. # # The short X.Y version. -version = '0.1a' +version = '0.11' # The full version, including alpha/beta/rc tags. -release = '0.1a' +release = '0.11 Alpha' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/docs/index.rst b/docs/index.rst index 7dd43b77..45d5df79 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,10 +6,17 @@ Welcome to xterm.js's documentation! ==================================== +This is the documentation for xterm.js. Xterm.js is a full xterm clone, written completely in JavaScript. + +Xterm.js supplye a modular, event-based interface that lets developers build addons and themes that augment +the experience of running a fully-feature terminal inside the browser. + +Xterm.js serves as the foundation for the terminal found at www.sourcelair.com. + Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 events