fixed crash in murphy plugin

[profile/ivi/automotive-message-broker.git] / README

diff --git a/README b/README
index b7ac8ce..9091660 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
 Automotive Message Broker is a vehicle network abstraction system.  It brokers information from the vehicle
-to applications.
+to applications.  It provides application with a rich API for accessing vehicle data.
 
-Automotive Message Broker is built using CMake and requires libltdl (libtool), json-glib, and boost packages.  
+Automotive Message Broker is built using CMake and requires libltdl (libtool), libjson-c, and boost packages.  
 
 
 About the Git Tree:
 master is expected to be unstable and may not even compile.  If you want something more stable, checkout one of the 
-release branches (ie, 0.9.0, 0.10.0, etc)
+release branches (ie, 0.9.0, 0.10, etc)
 
 
 To build:
@@ -43,24 +43,8 @@ ambd -c /path/to/myconfig
 
 also see ambd -h
 
-
-Running on multiple machines
-
-ambd can run on multiple machines and share data across a network.  This is primarily done through the websocket
-sink and source plugins.  The server machine, the machine with physical access to data, runs the 
-websocket sink plugin and the client, the machine elsewhere on the network, runs the websocket source plugin.
-
-There are example configurations in the source called "configwebsocketsink" and "configwebsocketsource" that
-show how to configure ambd.  These are found in the examples folder.
-
-Here's an example on how to run:
-
-cd automotive-message-broker/examples
-ambd -c configwebsocketsink
-
-(in another terminal)
-ambd -c configwebsocketsource
-
+Typically, AMB will be used with the DBus plugin.  The DBus plugin automatically makes internal AMB properties 
+available over DBus.  See the DBus plugin documentation for more information (plugins/dbus/README).
 
 
 Running with other plugins
@@ -68,16 +52,12 @@ Running with other plugins
 To learn about running AMB with other plugins, please see the plugins/*/README.  
 
 
-
 Running with the Qt mainloop:
 
-Some source and sink plugins may want to use the Qt-based mainloop.  To enable the Qt mainloop, run cmake
-with -Duse_qtcore=On:
-
-cmake .. -Duse_qtcore=On
+Some source and sink plugins may want to use the Qt-based mainloop to take advantage of Qt features. To enable
+the Qt mainloop, run cmake with -Duse_qtcore=On:
 
-Alternatively, the Qt-based mainloop will be enabled if you enable an Qt-based
-source or sink plugin at compile time.
+cmake .. -Dqtmainloop=On
 
 You will also need to edit your config to enable the Qt-based mainloop: