Skip to content

Commit

Permalink
Fixed review comments
Browse files Browse the repository at this point in the history
Signed-off-by: artem.ivanov <[email protected]>
  • Loading branch information
Artemkaaas committed Nov 26, 2018
1 parent 8d7c9e5 commit b9dd90c
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 9 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ Indy SDK provides libindy wrappers for the following programming languages and p
* [iOS](wrappers/ios/README.md)
* [NodeJS](wrappers/nodejs/README.md)
* [.Net](wrappers/dotnet/README.md)
* [Rust](wrappers/rust/README.md)


### Indy CLI
Expand Down Expand Up @@ -77,10 +78,14 @@ Indy SDK provides libvcx wrappers for the following programming languages and pl

These wrappers are currently in **experimental** state and it is not part of official releases.

### Dummy Cloud Agent
[Dummy Cloud Agent](/vcx/dummy-cloud-agent/README.md) is a simple HTTP server which implements Agent2Agent communication protocol required for full VCX work.
##### Example use
For the main workflow example check [VCX Python demo](https://github.com/hyperledger/indy-sdk/tree/master/vcx/wrappers/python3/demo).

This library is currently in an **experimental** state and is not part of official releases.
### Dummy Cloud Agent
[Dummy Cloud Agent](/vcx/dummy-cloud-agent/README.md) is simple implementation of VCX compatible Cloud Agent.
The main purpose of this implementation is VCX testing, demos and documentation of VCX protocol.
There is an parallel work on providing reference implementation of Agent2Agent protocol in indy-agent repo.
We plan to migrate to this protocol and implementation soon.

## How-To Tutorials

Expand Down
5 changes: 3 additions & 2 deletions vcx/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ it should finish successfully.

To build libvcx on your own you can follow these steps --
1) Install rust and rustup (https://www.rust-lang.org/install.html).
2) Install libindy (https://repo.evernym.com/libindy/).
2) Install or build libindy (https://repo.evernym.com/libindy/).
- As of now there is no distribution channel for OSX for LibIndy. [You have to build it manually.](https://github.com/hyperledger/indy-sdk/blob/master/doc/mac-build.md)
- Copy generated `libindy.dylib` file to `/usr/local/lib`
- Or create a symlink in `/usr/local/lib` pointing to newly generated `libindy.dylib`, this will help in updating the libindy in future.
Expand Down Expand Up @@ -141,4 +141,5 @@ The following wrappers are tested and complete.
## Getting started guide
[The tutorial](docs/getting-started/getting-started.md) which introduces Libvcx and explains how the whole ecosystem works, and how the functions in the SDK can be used to construct rich clients.
### Example use
For the main workflow example check [demo](https://github.com/hyperledger/indy-sdk/tree/master/vcx/wrappers/python3/demo).
7 changes: 5 additions & 2 deletions vcx/dummy-cloud-agent/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
# Dummy Cloud Agent

This is a simple HTTP server which implements Agent2Agent communication protocol required for full [VCX](../README.md) work.
This is simple implementation of VCX compatible Cloud Agent.

This library is currently in an **experimental** state and is not part of official releases.
The main purpose of this implementation is VCX testing, demos and documentation of VCX protocol.

There is an parallel work on providing reference implementation of Agent2Agent protocol in indy-agent repo.
We plan to migrate to this protocol and implementation soon.

## Run
cargo run <path-to-config>
2 changes: 1 addition & 1 deletion vcx/wrappers/python3/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,4 @@ python3 generateDocs.py
* A directory will be created locally `./docs` which contains subdirectories 'vcx' and within that 'api'. Html files are generated and put here that give details on each api function.

### Example use
For the main workflow example check [demo](https://github.com/hyperledger/indy-sdk/tree/master/vcx/wrappers/python3/demo).
For the main workflow example check [Python demo](https://github.com/hyperledger/indy-sdk/tree/master/vcx/wrappers/python3/demo).
1 change: 0 additions & 1 deletion vcx/wrappers/python3/demo/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ pool.txn - genesis files for connecting to an indy pool (existing file connects
To run these follow the next steps:
1) install the latest vcx python package
2) start Dummy Cloud Agent according to instruction: https://github.com/hyperledger/indy-sdk/tree/master/vcx/dummy-cloud-agent/README.md
2) start Dummy Cloud Agent according to instruction: https://github.com/hyperledger/indy-sdk/tree/master/vcx/dummy-cloud-agent/README.md
3) execute the faber.py script first with "python3.6 faber.py".
This script will explain what it is doing and output invite details.
4) When the invite details are displayed start the alice.py script with "python3.6 alice.py".
Expand Down

0 comments on commit b9dd90c

Please sign in to comment.