Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Simply VC authored May 14, 2020
1 parent b37a82b commit 472accd
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Oasis API Server

[![version](https://img.shields.io/github/tag/SimplyVC/oasis_api_server.svg)](https://github.com/SimplyVC/oasis_api_server/releases/latest)
[![Go Report Card](https://goreportcard.com/badge/github.com/SimplyVC/oasis_api_server)](https://goreportcard.com/report/github.com/SimplyVC/oasis_api_server)
[![LoC](https://tokei.rs/b1/github/SimplyVC/oasis_api_server)](https://github.com/SimplyVC/oasis_api_server)

<img src="./docs/OASIS.png" alt="design" />

The Oasis API Server is a wrap-around of the [Oasis Protocol Golang API](https://github.com/oasislabs/oasis-core). This makes it easier to use the protocol's API with any programming language in order to query data from the Oasis nodes. This server is also able to query data from the Oasis nodes' exposed Prometheus endpoint.
Expand All @@ -14,4 +18,4 @@ If you want to dive into the design and feature set of the API Server [click her

## Ready, Set, Query!

If you are ready to try out the API Server on your Oasis nodes, setup and run the API Server using [this](docs/INSTALL_AND_RUN.md) guide.
If you are ready to try out the API Server on your Oasis nodes, setup and run the API Server using [this](docs/INSTALL_AND_RUN.md) guide.

0 comments on commit 472accd

Please sign in to comment.