summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-06-12 09:36:44 +0200
committerRomain Forlot <romain.forlot@iot.bzh>2017-06-12 09:36:44 +0200
commita3e6126b082335cb9722c6b8d5321dd39d6d2dca (patch)
treed4d1bd6f330a624f7c85c86269b15d686a840ff9 /docs/README.md
parent4788a840abe82f2c0f20b027589085d29051763c (diff)
Updating README and add usage documentation.
Change-Id: I1bc2ef589ef60098cd1c1eb203e3140c0c955eed Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..f22761a
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,8 @@
+# Abstract
+
+This project proposes a High Level CAN Binding for AGL, with the following features:
+
+* Interface between UI and Low Level CAN binding
+* Generation of ViWi resources based on a json configuration description
+* Connection to Low Level binding in order to maintain Viwi objects status
+* Accepts subscriptions and gets events, and generate in reply Json messages in ViWi format