diff --git a/README.md b/README.md index da1d1a4..f255cd5 100644 --- a/README.md +++ b/README.md @@ -18,18 +18,18 @@ This server is used to get the appObjects and generalData for the webApp clients #### sendGeneralData webAppClient.sendGeneralData(message, type, options = {}) Sends a message to the cloud via webAppServer -message: content of the message -type: type of the message +* message: content of the message +* type: type of the message #### requestGeneralData webAppClient.requestGeneralData(type, vectorClock = '0') Requests the generalData from webAppServer -type: type of the message -vectorClock: vectorClock after which the message should be requested (can be used with Date.now()) (default = '0') -Returns an object (set of generalData) +* type: type of the message +* vectorClock: vectorClock after which the message should be requested (can be used with Date.now()) (default = '0') +* Returns an object (set of generalData) #### requestObjectData webAppClient.requestObjectData(keyPath) Requests the objectData/appObjects from webAppServer -path: (an Array) path of the required object (eg. \['Sample', Property1, property2..] -Returns an Object/Array (requested path) +* path: (an Array) path of the required object (eg. \['Sample', Property1, property2..] +* Returns an Object/Array (requested path)