Merge branch 'master' into cli-comments

Author: jovfer

README.md

@@ -15,34 +15,34 @@ in project IS (note that regular Indy tickets are in the INDY project instead...
 us on [Hyperledger's Rocket.Chat](https://chat.hyperledger.org/) at #indy-sdk to discuss.
 
 
-## How to install
+## Installation
 ### Release channels
 Indy SDK release process defines the following release channels:
-    
+
 * `master` - development builds for each push to master branch.
 * `rc` - release candidates.
 * `stable` - stable releases.
 
 Please refer to [release workflow](doc/release-workflow.md) for more details.
-### Install for Ubuntu based distro (Ubuntu 16.04)
+
+### Ubuntu based distributions (Ubuntu 16.04)
 It is recommended to install packages with APT:
-    
+
     apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 68DB5E88
     sudo add-apt-repository "deb https://repo.sovrin.org/sdk/deb xenial {release channel}"
     sudo apt-get update
     sudo apt-get install -y libindy
 
 {release channel} must be replaced with master, rc or stable to define corresponded release channel.
-See section "Release channels" for more details.  
-   
-### Install for Windows
+See section "Release channels" for more details.
+
+### Windows
 
 1. follow to https://repo.sovrin.org/windows/libindy/{release-channel}.
 2. download last version of libindy.
 3. unzip archives to directory, where you want to save working library.
 4. After unzip you will get next structure of files:
 
-    
 * `Your working directory`
     * `include`
         * `...`
@@ -52,64 +52,67 @@ See section "Release channels" for more details.
         * `libsodium.dll`
         * `libzmq.dll`
         * `ssleay32md.dll`
-            
+
 `include` contains c-header files which contains all necessary declarations
-that may be need for your applications. 
+that may be need for your applications.
 
 `lib` contains all necessary binaries which contains libindy and all it's dependencies.
  `You must add to PATH environment variable path to lib`. It's necessary for dynamic linkage
- your application with libindy.       
+ your application with libindy.
 
 {release channel} must be replaced with master, rc or stable to define corresponded release channel.
 See section "Release channels" for more details.
-### Install for iOS
 
+### iOS
 See [wrapper iOS install documentation](wrappers/ios/README.md "How to install").
 
-### Install for MacOS        
-Now we haven't prebuild library in some shared place. You can build
-library yourself. Please refer to How-to-build section. 
+### MacOS
+
+Pre-built libraries are not provided for MacOS. Please look [here](doc/mac-build.md)
+for details on building from source for MacOS.
 
-After build add to LD_LIBRARY_PATH and to DYLD_LIBRARY_PATH 
-environment variables path to builded library. It's necessary 
-for dynamic linkage your application with libindy. At first dynamic linker
-browse library in LD_LIBRARY_PATH, if library in your application doesn't include directory names.
-If library in your application include any directory name, then dynamic linker will search library
-in DYLD_LIBRARY_PATH(not LD_LIBRARY_PATH). So for reliability we recommend you set both this variables.
-            
-### Install for RHEL based distro (Amazon Linux 2017.03)           
-Now we haven't prebuild library in some shared place. You can build
-library yourself. Please refer to How-to-build section.
+After building `libindy`, add the path containing the library the `LD_LIBRARY_PATH` and
+`DYLD_LIBRARY_PATH` environment variables. This is necessary for dynamically linking
+your application with `libindy`. The dynamic linker will first check for the library in
+`LD_LIBRARY_PATH` if the library in your application doesn't include directory names.
+If the library in your application does include any directory name, then dynamic
+linker will search for the library in `DYLD_LIBRARY_PATH` (not `LD_LIBRARY_PATH`)
+so we recommend you set both variables to be safe.
 
-After build add to LD_LIBRARY_PATH environment variable path to builded library. 
-It's necessary for dynamic linkage your application with libindy.
+### RHEL-based distributions (Amazon Linux 2017.03)
+Pre-built libraries are not provided for RHEL-based distributions. Please look [here](doc/rhel-build.md)
+for details on building from source for RHEL-based distributions.
+
+After successfully compiling `libindy`, you will need to add the path containing `libindy.so` to the
+`LD_LIBRARY_PATH` environment variable. This is required for your application to link to
+`libindy`.
 
 ## How to build
 
-* [Ubuntu based distro (Ubuntu 16.04)](doc/ubuntu-build.md)
-* [RHEL based distro (Amazon Linux 2017.03)](doc/rhel-build.md)
+* [Ubuntu based distributions (Ubuntu 16.04)](doc/ubuntu-build.md)
+* [RHEL based distributions (Amazon Linux 2017.03)](doc/rhel-build.md)
 * [Windows](doc/windows-build.md)
 * [MacOS](doc/mac-build.md)
 
 ## How to start local nodes pool with docker
 
 Start local nodes pool on `127.0.0.1:9701-9708` with Docker:
-          
-```     
+
+```
 docker build -f ci/indy-pool.dockerfile -t indy_pool .
 docker run -itd -p 9701-9708:9701-9708 indy_pool
-```     
-     
- Dockerfile `ci/indy-pool.dockerfile` supports optional pool_ip param that allows 
- changing ip of pool nodes in generated pool configuration. The following commands 
- allow to start local nodes pool in custom docker network and access this pool 
+```
+
+ Dockerfile `ci/indy-pool.dockerfile` supports optional pool_ip param that allows
+ changing ip of pool nodes in generated pool configuration. The following commands
+ allow to start local nodes pool in custom docker network and access this pool
  by custom ip in docker network:
-     
+
  ```
  docker network create --subnet 10.0.0.0/8 indy_pool_network
  docker build --build-arg pool_ip=10.0.0.2 -f ci/indy-pool.dockerfile -t indy_pool .
  docker run -d --ip="10.0.0.2" --net=indy_pool_network indy_pool
- ``` 
+ ```
  Note that for Windows and MacOS this approach has some issues. Docker for these OS run in
  their virtual environment. First command creates network for container and host can't
  get access to that network because container placed on virtual machine. You must appropriate set up 

doc/design/wallet/storage-interface.puml

@@ -0,0 +1,35 @@
+@startuml storage-interface
+
+interface WalletStorage {
+    + {static} create(name, config, cred)
+    + {static} delete(name, config, cred)
+    + {static} open(name, config, r_config, cred) -> WalletStorage
+    + add_record(type, id, value, tags)
+    + update_record_value(type, id, value)
+    + update_record_tags(type, id, tags)
+    + add_record_tags(type, id, tags)
+    + delete_record_tags(type, id, tag_names)
+    + delete_record(type, id)    
+    + get_record(type, id, options) -> Record
+    + search_records(type, query, options) -> Search
+    +close()
+}
+
+interface Search {
+    + get_total_count() -> u32
+    + get_count() -> u32
+    + next_wallet_entity() -> Record
+    + free()
+}
+Search --* WalletStorage
+
+interface Record {
+    + get_id() -> str
+    + get_value() -> str
+    + get_tags() -> str
+    + free()
+}
+Record --* WalletStorage
+Record --* Search
+
+@enduml