Browse Source

tweak readme

Mark deVilliers 2 years ago
parent
commit
c65d053d1b
1 changed files with 5 additions and 4 deletions
  1. 5 4
      README.md

+ 5 - 4
README.md

@@ -17,7 +17,7 @@ Data Entitlement
17 17
 An introduction to concepts of data entitlements as well as a review of prior art was completed as part of the DECODE project.
18 18
 This document can be found [here](https://desk.dyne.org/s/7gHFaUIoNEFB1Wx#pdfviewer).
19 19
 
20
-For the purposes of the prototype we have defined any singular piece of  data in our system as being in one of three logical states -
20
+For the purposes of the prototype any singular piece of data in our system will be in one of three logical states -
21 21
 - owner-only - the data is not discoverable or accessible.
22 22
 - can-discover - the data is discoverable and there will be made available for search. The data is not accessible.
23 23
 - can-access - the data is accessible and by default discoverable.
@@ -27,7 +27,7 @@ It is important to note that the prototype does not, by design, implement authen
27 27
 Architecture
28 28
 ------------
29 29
 
30
-The prototype is implemented as a set of HTTP services exposing various endpoints accepting various JSON messages in a REST-like manner.
30
+The prototype is implemented as a set of HTTP services, written in golang, exposing various endpoints accepting various JSON messages in a REST-like manner.
31 31
 Each of the services is documented with a [swagger api](https://swagger.io/)
32 32
 
33 33
 An overview of a single node system.
@@ -36,9 +36,10 @@ An overview of a single node system.
36 36
 
37 37
 In this diagram two IoT devices logically direct their data to the node service.
38 38
 As a convenience we have included fake IoT devices as part of the prototype.
39
-The output of these fake devices correspond to the output of the [device-hub](https://github.com/thingful/device-hub) component as developed by [thingful](https://thingful.net).
39
+The output of these fake devices correspond to the output of the [device-hub](https://github.com/thingful/device-hub) component as developed by [thingful](https://thingful.net)
40
+and open-sourced as part of the DECODE project.
40 41
 
41
-The node service owns an instance of the storage service.
42
+The node service is the entry point for an instance of the storage service.
42 43
 The node has a relationship with the metadata service.
43 44
 
44 45
 The node service is responsible for: