Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update readme #320

Merged
merged 3 commits into from
Nov 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,49 @@

![Logo!](assets/ojo.png)

[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/badges/latest/active.svg)
[![Go Report Card](https://goreportcard.com/badge/github.com/ojo-network/ojo?style=flat-square)](https://goreportcard.com/report/github.com/ojo-network/ojo)
[![Version](https://img.shields.io/github/v/tag/ojo-network/ojo.svg?style=flat-square)](https://github.com/ojo-network/ojo/releases/latest)
[![License: Apache-2.0](https://img.shields.io/github/license/ojo-network/ojo.svg?style=flat-square)](https://github.com/ojo-network/ojo/blob/main/LICENSE)
[![GitHub Super-Linter](https://img.shields.io/github/workflow/status/ojo-network/ojo/Lint?style=flat-square&label=Lint)](https://github.com/marketplace/actions/super-linter)
[![GitHub Super-Linter](https://img.shields.io/github/actions/workflow/status/ojo-network/ojo/lint.yml?branch=main)](https://github.com/marketplace/actions/super-linter)

> A Golang Implementation of the Ojo Network, a cosmos-first oracle
> A Golang Implementation of the Ojo Network, a decentralized oracle
> with DeFi safety in mind.

Ojo is an oracle platform which other blockchains and smart contracts can use to receive
up-to-date and accurate data. This platform arose from our work at
[Umee](https://github.com/umee-network/umee), where we worked on developing our
own oracle based off of the [Terra Classic](https://github.com/terra-money/classic-core) design.
Now, we specalize bringing the lessons we've learned to the greater Cosmos.

Ojo is able to provide pricing info via IBC, CosmWasm, and EVM. MoveVM support is coming shortly.

## Table of Contents

- [Table of Contents](#table-of-contents)
- [Releases](#releases)
- [Install](#install)
- [Networks](#networks)

## Releases

Our releases are tagged and binaries are produced [here](https://github.com/ojo-network/ojo/releases).

See [Release procedure](contributing.md#release-procedure) for more information about the release model.

Currently, there is no official release of the `ojod` binary.
## Install

To install the `ojod` binary:

```shell
$ make install
```

## Networks

Ojo currently has three active public networks:

| Network Name | Type | Docs |
| :-----------------------------------------------: | :---------------: | :------------------------------------------------: |
| [Agamotto](https://agamotto.ojo.network/agamotto) | Mainnet | [Docs](https://docs.ojo.network/networks/agamotto) |
| [Ditto](https://agamotto.ojo.network/ditto) | Testnet | N/A |
| [Sauron](https://sauron.ojo.network/) | Validator Testnet | [Docs](https://docs.ojo.network/networks/sauron) |
Loading