Merge pull request #13 from apache/update_readme
Update readme
diff --git a/README.md b/README.md
index c6e04e9..cf240f6 100644
--- a/README.md
+++ b/README.md
@@ -21,8 +21,27 @@
---
[](https://GitHub.com/Naereen/StrapDown.js/graphs/commit-activity)
-Milagro Custody DTA creates an ecosystem in which service providers can issue and protect secrets. When a node is connected to the network it is able to discover service providers who are able to offer secure long term storage of highly sensitive digital assets. It is written in Go and uses REST services based on the GoKit microservices framework: https://gokit.io/
+Milagro D-TA is a colaborative key management server
+Milagro D-TA facilitates secure and auditable communication between people who to use key pairs (Principal) and service providers who can keep the secret keys safe (Master Fiduciary). It is written in Go and uses REST services based on the [GoKit microservices framework](https://gokit.io), it uses IPFS to create a shared immutable log of transactions and relies on Milagro-Crypto-C for it's crypto.
+
+## Plugins
+Milagro D-TA provides a basic set of services for creating identities for actors in the system, and passing encrypted communication between them but it assumes that different service providers will have their own "special sauce" for securely storing secret keys, so the vanilla services can be extended using a plugin framework. Two basic plugins are included in this release to give you an idea of how this can be done.
+1. **BitcoinPlugin** Generates a Bitcoin address and reveals the corresponding secret key
+2. **SafeGuardSecret** Encrypts a string and decrypts it again
+
+## Instalation
+To see Milagro D-TA in action you can run Milagro D-TA in a docker container
+
+```
+git clone https://github.com/apache/incubator-milagro-dta.git
+
+cd incubator-milagro-dta
+
+docker build -t mydta .
+
+docker run -p5556:5556 mydta
+```
## Dependencies
@@ -39,7 +58,9 @@
make \
libtool \
automake \
- libssl-dev
+ libssl-dev \
+ jq \
+ curl
sudo apt-get clean
```
@@ -51,7 +72,7 @@
```
git clone https://github.com/open-quantum-safe/liboqs.git
-cd liboq
+cd liboqs
git checkout 7cb03c3ce9182790c77e69cd21a6901e270781d6
autoreconf -i
./configure --disable-shared --disable-aes-ni --disable-kem-bike --disable-kem-frodokem --disable-kem-newhope --disable-kem-kyber --disable-sig-qtesla
@@ -71,7 +92,7 @@
cd incubator-milagro-crypto-c
mkdir build
cd build
-cmake -D CMAKE_BUILD_TYPE=Release -D BUILD_SHARED_LIBS=OFF -D AMCL_CHUNK=64 -D AMCL_CURVE="BLS381,SECP256K1" -D AMCL_RSA="" -D BUILD_PYTHON=OFF -D BUILD_BLS=ON -D BUILD_WCC=OFF -D BUILD_MPIN=OFF -D BUILD_X509=OFF -D CMAKE_INSTALL_PREFIX=/usr/local ..
+cmake -D CMAKE_BUILD_TYPE=Release -D BUILD_SHARED_LIBS=ON -D AMCL_CHUNK=64 -D AMCL_CURVE="BLS381,SECP256K1" -D AMCL_RSA="" -D BUILD_PYTHON=OFF -D BUILD_BLS=ON -D BUILD_WCC=OFF -D BUILD_MPIN=OFF -D BUILD_X509=OFF -D CMAKE_INSTALL_PREFIX=/usr/local -DCMAKE_C_FLAGS="-fPIC" ..
make
make test
sudo make install
@@ -82,40 +103,25 @@
cd incubator-milagro-dta/libs/crypto/libpqnist
mkdir build
cd build
-cmake -D CMAKE_INSTALL_PREFIX=/usr/local ..
+cmake -D CMAKE_INSTALL_PREFIX=/usr/local -D BUILD_SHARED_LIBS=ON ..
make
make test
sudo make install
### golang
-The code is written in golang primarily with a wrapper around some C code.
+Download and install [Golang](https://golang.org/dl/)
-```
-wget https://dl.google.com/go/go1.12.linux-amd64.tar.gz
-tar -xzf go1.12.linux-amd64.tar.gz
-sudo cp -r go /usr/local
-echo 'export PATH=$PATH:/usr/local/go/bin' >> ${HOME}/.bashrc
-```
-
-#### configure GO
-
-```
-mkdir -p ${HOME}/go/bin
-mkdir -p ${HGME}/go/pkg
-mkdir -p ${HOME}/go/src
-echo 'export GOPATH=${HOME}/go' >> ${HOME}/.bashrc
-echo 'export PATH=$GOPATH/bin:$PATH' >> ${HOME}/.bashrc
-```
-
-This package is needed for testing.
-
-```
-go get github.com/stretchr/testify/assert
-```
## Run service
+Set the library paths
+
+```
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/usr/local/lib
+export C_INCLUDE_PATH=$C_INCLUDE_PATH:/usr/local/lib
+```
+
This script will build the service
```
@@ -128,26 +134,16 @@
./target/service
```
-## Developer Notes
+## Documentation
-You need to install protobufs
+You can find documentation for Milagro D-TA in the main [Milagro docs site](https://milagro.apache.org/)
-If you change the portobufs definition run
+Which includes a quick start guide that will show you how to get Milagro D-TA to "do stuff"
-$ protoc -I=. --go_out=. ./docs.proto
-To add a new endpoint to the goKit Microservices framework
+## Contributing
-1. First define the contract in milagro/pkg/milagroservice/proto.go
-
-Add structs for http transport
-Add responses to milagro/swagger/swagger.config,yaml
-
-2. Add an endpoint definition
-
-milagro/pkg/milagroendpoints/endpoints.go
-
-3. Create a handler factory
+ Key pairs are becoming central to our online lives, and keeping secret keys safe is a growing industry, we hope to create an ecosystem of custodial service providers who colabroate to make the Internet a safer place for everyone. We are keen to get contributions and feedback from anyone in this space. This is a brand new project so our development processes are still being figured out, but if you have suggestions, questions or wish to make contributions please go ahead raise an issue and someone on the team will get right on it.
## Crypto Notice
@@ -173,6 +169,11 @@
Apache Milagro is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
+## Credits
-
-
+* Design and Concept... [Brian Spector](https://github.com/spector-in-london)
+* Core Algorithm and Services... [Chris Morris](https://github.com/fluidjax)
+* Framework and Refactoring... [Stanislav Mihaylov](https://github.com/smihaylov)
+* Crypto Genius... [Kealan McCusker](https://github.com/kealan)
+* Keeper of "The Apache Way"... [John McCane-Whitney](https://github.com/johnmcw)
+* Prototype and Cat Herding... [Howard Kitto](https://github.com/howardkitto)
\ No newline at end of file
