From 9412077eea3be2e6725d4a10bcff5cf6e34648a7 Mon Sep 17 00:00:00 2001 From: David Garcia Date: Tue, 21 Jan 2020 10:17:21 +0000 Subject: [PATCH] Updated README.md with docs links --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index b1d9a5ea9..3ec9c2573 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![Build Status](https://api.travis-ci.org/nemtech/catapult-rest.svg?branch=master)](https://travis-ci.org/nemtech/catapult-rest) [![Coverage Status](https://coveralls.io/repos/github/nemtech/catapult-rest/badge.svg?branch=master)](https://coveralls.io/github/nemtech/catapult-rest?branch=master) +Catapult REST gateway combines HTTP and WebSockets to perform read and write actions on the blockchain. + ## Requirements - NodeJS version 8 or 9 @@ -38,6 +40,10 @@ cd rest yarn start resources/rest.json ``` +## Usage + +Please refer to the [documentation](https://nemtech.github.io/api.html) for more information. + ## Contributing Before contributing please [read this](CONTRIBUTING.md) and consider the following guidelines: