diff --git a/README.md b/README.md index c8a267614..78232d730 100644 --- a/README.md +++ b/README.md @@ -6,25 +6,6 @@ [![codecov](https://codecov.io/gh/trustbloc/edge-service/branch/master/graph/badge.svg)](https://codecov.io/gh/trustbloc/edge-service) [![Go Report Card](https://goreportcard.com/badge/github.com/trustbloc/edge-service)](https://goreportcard.com/report/github.com/trustbloc/edge-service) -## Prerequisites (for running tests and demos) -- Go 1.13 -- Docker -- Docker-Compose -- Make - -## Targets -``` -# run checks and unit tests -make all -# run linter checks -make checks -# run unit tests -make unit-test -``` - -## Build -To build from source see [here](docs/build.md). - # edge-service Edge Service is a reference implementation that demonstrates the following story: @@ -38,6 +19,9 @@ operations: - Retrieve verifiable credential from [EDV](https://github.com/trustbloc/edv) - Verify verifiable credential +## Build +To build from source see [here](docs/build.md). + # Documentation - [VC REST APIs](docs/vc-rest/api_overview.md) - [OpenAPI Spec](docs/vc-rest/openapi_spec.md) diff --git a/docs/build.md b/docs/build.md index 2fd78fa23..ca038768c 100644 --- a/docs/build.md +++ b/docs/build.md @@ -12,11 +12,22 @@ ## Targets - # run checks and unit tests - make all +``` +# run checks and unit tests +make all + +# run linter checks +make checks + +# run unit tests +make unit-test + +# run checks and unit tests +make all - # run BDD tests - make bdd-test +# run BDD tests +make bdd-test +``` ## BDD Test Prerequisites