Skip to content
This repository has been archived by the owner on Jun 10, 2022. It is now read-only.

Commit

Permalink
Updated README.md with docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
@dgarcia360 @Vektrat
dgarcia360 authored and Vektrat committed Jan 21, 2020
1 parent eea36c7 commit 9412077
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 9412077

Please sign in to comment.