Added Release Notes from Sudarshan.

Change-Id: Ibff971b9b9ba6b42f08b427503cc44d5b40b4f59

diff --git a/RELEASE.txt b/RELEASE.txt
new file mode 100644 (file)
index 0000000..c8cd4a4
--- /dev/null
+++ b/RELEASE.txt
@@ -0,0 +1,98 @@
+Release notes\r
+Release date: Aug 5th, 2014. \r
+OS: Ubuntu 12.0.4 and above\r
+Requires boost version 1.55 to build. \r
+NOTE: Boost is not distributed but should be installed in the Ubuntu machine. \r
+\r
+What\92s new?\r
+Class OCPlatform (Header file: OCPlatform.h)\r
+registerResource API (signature update)\r
+\95This API provides the ability to register the resource with its name, type and list of properties\r
+\95Signature of this API has changed. The API takes reference to resource handle which will be filled upon successful registration. Other parameters include resource URI, resource Type, resource interface, entity handler address and resource property (whether discoverable, observable etc.). \r
+\95NOTE: This applies to server side functionality. \r
+\95NOTE: This API might get modified to accommodate for resource collection in future.\r
+\r
+notifyObservers API\r
+\95This new API provides the ability to notify core that resource\92s attributes have changed. When entity handler is ready to indicate core that a resource has changed, notifyObservers API needs to be invoked.\r
+\95This API takes resource handle as the only parameter. \r
+\95NOTE: This applies to server side functionality. \r
+\95NOTE: This API might get modified to accommodate for resource collection in future.\r
+\r
+Class OCResource (Header file: OCResource.h)\r
+\r
+get API\r
+\95This new API provides the ability to get the attributes of a resource. This API takes a callback as parameter. Callback will be invoked with Attribute map which will provide representation of the resource. Callback will also include error code for GET operation. \r
+\95NOTE: This applies to client side functionality. \r
+\95NOTE: This API might get modified to accommodate for resource collection in future.\r
+\r
+put API\r
+\95This new API provides the ability to set the attributes of a resource via PUT. \r
+\95This API takes Attribute map, query parameter map and a callback as parameters. Callback will be invoked with Attribute map which will provide current representation of the resource. Callback will also include error code for PUT operation. \r
+\95NOTE: This applies to client side functionality. \r
+\95NOTE: This API might get modified to accommodate for resource collection in future.\r
+\r
+Observe API\r
+\95This new API provides the ability for the client to set observation on a resource\r
+\95This API provides callback as a parameter. Callback will be invoked with attribute map and with an error code for this operation. \r
+\95NOTE: This applies to client side functionality. \r
+\r
+cancelObserve API\r
+\95This new API provides the ability for the client to cancel observation on a resource\r
+\95This API provides callback as a parameter. Callback will be invoked with error code for this operation. \r
+\95NOTE: This applies to client side functionality. \r
+Class OCResourceRequest (Header file: OCResourceRequest.h)\r
+NOTE: This applies to server side functionality. \r
+\r
+getRequestType API\r
+\95This new API provides the ability to retrieve the type of request. This could be GET, PUT (and in future POST and DELETE).\r
+\r
+getQueryParams API\r
+\95This new API provides the ability to retrieve the query parameters from the URL request. \r
+\r
+getRequestHandlerFlag API\r
+\95This new API provides the ability to retrieve the request handler flag on the URL request. This could be either INIT, REQUEST or OBSERVE flag. \r
+\r
+getResourceRepresentation API\r
+\95This new API provides the ability to retrieve attribute representation of the resource. \r
+\r
+Class OCResourceResponse (Header file: OCResourceResponse.h)\r
+NOTE: This applies to server side functionality. \r
+\r
+setErrorCode API\r
+\95This new API provides the ability to set the error code\r
+\r
+setResourceRepresentation API\r
+\95This new API provides the ability to set the attribute representation of a resource.  \r
+\r
+Other Notes:\r
+1.     Security model is still open. \r
+2.     APIs have OCStackResult as return type. This is will indicate success or failure for the API operation. \r
+3.     Resource collection/hierarchy APIs are not checked into the code base. They will be given as separate header files.  \r
+4.     Query parameters are not used in this deliverable.\r
+5.     Only single client observer has been tested.\r
+6.     Maximum length of URI supported is 64 bytes\r
+7.     Maximum length of response (for GET, PUT) from server is 128 bytes.\r
+\r
+\r
+How to build:\r
+1.     In repo oic-core, root folder ccf-resource consists of \91OIC\92 folder.  Inside OIC folder there is a Makefile. \r
+2.     Before building, make sure to have contents from oic-utilities repo at the folder level where oic-core is. This would be ccf-utilities. \r
+3.     Use \91make\92 to build the entire OIC code. This would build the C++ SDK, stack and samples. \r
+\r
+Samples:\r
+1.     We have a sample for hosting a resource on a server and a sample for client which will be able to discover resources. \r
+2.     Server sample location: OIC/examples/simpleserver.cpp\r
+3.     Client sample location: OIC/examples/simpleclient.cpp\r
+4.     In simpleserver.cpp, inside main, \r
+\r
+PlatformConfig cfg;\r
+cfg.ipAddress = "134.134.161.33";\r
+\r
+Modify the above IP address to the IP address of the machine where this server is running. \r
+\r
+Similarly, in simpleclient.cpp, inside main, modify the IP address to the IP address of the machine where the client is running. \r
+\r
+The server and client can run in same machine or in different machines.\r
+\r
+5. To run simpleServer do \91./simpleServer\92 and to run simpleClient do \91./simpleClient\92.\r
+\r