summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md37
1 files changed, 32 insertions, 5 deletions
diff --git a/README.md b/README.md
index 3db0ea2..c78adea 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,36 @@
# uSCXML ReadMe
-uSCXML is a SCXML interpreter written in platform independent C/C++. It is still in a rather early stage but mostly
-feature-complete as far as the W3C SCXML draft specifies.
+uSCXML is a SCXML interpreter written in C/C++. It is still in a rather early stage but mostly
+feature-complete as far as the W3C SCXML draft specifies. It runs on most <b>Linux</b>,
+<b>Windows</b> and <b>MacOSX</b>, each 32- as well as 64Bits.
- * ECMAScript datamodel using Google's v8 implementation
- * Full DOM implementation via Arabica
- * Integrates with uMundo to provide publish / subscribe
+There is no technical reason for it not to run on iOS and Android as well, but we did not yet setup
+the respective build-process.
+ * <b>Datamodels</b>
+ * ECMAScript using Google's v8 and JavaScriptCore (JSC is incomplete)
+ * Prolog using SWI prolog
+ * <b>Invokers</b>
+ * <tt>scxml</tt>: Invoke a nested scxml interpreter
+ * <tt>dirmon</tt>: Watches a directory for changes to files
+ * <tt>scenegraph</tt>: Simplified 3D scenegraphs with custom markup
+ * <tt>heartbeat</tt>: Periodically sends events
+ * <tt>httpservlet</tt>: Sends events for http requests to special paths
+ * <tt>umundo</tt>: Subscribe to channels and publish events
+ * <b>DOM</b>
+ * DOM Core Level 2 + XPath extensions available for ecmascript datamodel
+ * Namespace aware to embed custom markup for special invokers
+ * <b>Communication</b>
+ * Features the standard basichttp io-processor
+ * Can actually respond to HTTP requests with data via &lt;response>
+
+## License
+
+uSCXML itself is distributed under the Simplified BSD license as in, do not sue us and do
+not misrepresent authorship. Please have a look at the licenses of the [libraries we depend
+upon](https://github.com/tklab-tud/uscxml/blob/master/docs/BUILDING.md#build-dependencies) as well.
+
+## Download
+
+We do not yet feature installers. Please download the source and have a look at the [build
+instructions](https://github.com/tklab-tud/umundo/blob/master/docs/BUILDING.md).