From 75a147e0aa619c1849ec1431ac7a757880eecccd Mon Sep 17 00:00:00 2001 From: The Nystic <80164766+th3nyst1c@users.noreply.github.com> Date: Fri, 15 Dec 2023 18:50:22 +0100 Subject: [PATCH] docs(README): Fix hyperlinks + sync with fresh docs (#1711) * Update README.md Replacing a broken link * docs(README.md): Fix hyperlinks + sync with fresh docs --------- Co-authored-by: Unique Divine <51418232+Unique-Divine@users.noreply.github.com> --- README.md | 103 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 60 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index cf7328079..a3de5b04f 100644 --- a/README.md +++ b/README.md @@ -3,47 +3,31 @@ [![Go Reference](https://pkg.go.dev/badge/github.com/NibiruChain/nibiru.svg)](https://pkg.go.dev/github.com/NibiruChain/nibiru) [![Nibiru Test workflow][badge-go-linter]][workflow-go-linter] [![Nibiru Test workflow][badge-go-releaser]][workflow-go-releaser] -[![GitHub][license-badge]](https://github.com/NibiruChain/nibiru/blob/master/LICENSE.md) +[![GitHub][license-badge]](https://github.com/NibiruChain/nibiru/blob/main/LICENSE.md) [![Discord Badge](https://dcbadge.vercel.app/api/server/nibirufi?style=flat)](https://discord.gg/nibirufi) -**Nibiru Chain** is a proof-of-stake blockchain that unifies leveraged derivatives trading, spot trading, staking, and bonded liquidity provision into a seamless user experience, enabling users of over 40 blockchains to trade with leverage using a suite of composable decentralized applications. +**Nibiru Chain** is a breakthrough smart contract platform providing superior throughput, reduced latency, and improved security, all driven by Web Assembly (Wasm) smart contracts. -## Components of Nibiru - -- **CosmWasm Smart Contracts**: Rust-based, WebAssembly (WASM) smart contracts built for the Cosmos Ecosystem. See our [CosmWasm sandbox monorepo (cw-nibiru)](https://github.com/NibiruChain/cw-nibiru/tree/main) for the protocol's core smart contracts. -- **Nibi-Perps**: A perpetual futures exchange where users can take leveraged exposure and trade on a plethora of assets — completely on-chain, completely non-custodially, and with minimal gas fees. -- **Oracle Module**: Nibiru accurately prices assets using a native, system of decentralized oracles, and communicates with other Cosmos layer-1 chains using the Inter-Blockchain Communication (IBC) (opens new window)protocol. -- **Nibi-Swap**: An automated market maker protocol for multichain assets. This application gives users access to swaps, pools, and bonded liquidity gauges. - -## Modules - -| Module | Description | -| --- | --- | -| [common][code-x-common] | Holds helper and utility functions to be utilized by other `x/` modules. | -| [epochs][code-x-epochs] | Often in the SDK, we would like to run certain code every-so often. The purpose of `epochs` module is to allow other modules to set that they would like to be signaled once every period. So another module can specify it wants to execute code once a week, starting at UTC-time = x. `epochs` creates a generalized epoch interface to other modules so that they can easily be signalled upon such events. | -| [inflation][code-x-inflation] | Implements the [tokenomics](https://nibiru.fi/docs/learn/tokenomics.html) for Nibiru. | -| [oracle][code-x-oracle] | Handles the posting of an up-to-date and accurate feed of exchange rates from the validators. | -| [perp][code-x-perp] | Powers the Nibi-Perps exchange. This module enables traders to open long and short leveraged positions and houses all of the PnL calculation and liquidation logic. | -| [spot][code-x-spot] | Responsible for creating, joining, and exiting liquidity pools. It also allows users to swap between two assets in an existing pool. It's a fully functional AMM. | -| [wasm][code-x-wasm] | Implements the execution environment for [WebAssembly (WASM) smart contracts](https://book.cosmwasm.com/). | - -[code-x-common]: https://github.com/NibiruChain/nibiru/tree/master/x/common -[code-x-epochs]: https://github.com/NibiruChain/nibiru/tree/master/x/epochs -[code-x-inflation]: https://github.com/NibiruChain/nibiru/tree/master/x/inflation -[code-x-oracle]: https://github.com/NibiruChain/nibiru/tree/master/x/oracle -[code-x-perp]: https://github.com/NibiruChain/nibiru/tree/master/x/perp -[code-x-spot]: https://github.com/NibiruChain/nibiru/tree/master/x/spot -[code-x-wasm]: https://github.com/NibiruChain/nibiru/tree/master/x/wasm - -Nibiru is built with the [Cosmos-SDK][cosmos-sdk-repo] on [Tendermint Core](https://tendermint.com/core/) consensus, accurately prices assets using a system of decentralized oracles, and communicates with other Cosmos layer-1 chains using the [Inter-Blockchain Communication (IBC)](https://github.com/cosmos/ibc) protocol. +- [⚙️ — Documentation](#%EF%B8%8F--documentation) +- [💬 — Community](#--community) +- [🧱 — Components of Nibiru](#--components-of-nibiru) +- [⛓️ — Building: `make` commands](#%EF%B8%8F--building-make-commands) + - [Nibid CLI](#nibid-cli) + - [Running a Local Node](#running-a-local-node) + - [Generate the protobufs](#generate-the-protobufs) + - [Linter](#linter) + - [Multiple Nodes](#multiple-nodes) +- [License](#license) ## ⚙️ — Documentation -Conceptual and technical documentation can be found in the [Nibiru docs](https://docs.nibiru.fi). Detailed module-specific documentation is included in the top-level README (`x/module/README.md)`. +- [Docs | Nibiru Chain](https://nibiru.fi/docs/): Conceptual and technical documentation can be found here. +- [Complete Golang reference docs](https://pkg.go.dev/github.com/NibiruChain/nibiru): (`pkg.go.dev`) For the blockchain implementation . +- ["X Module"](https://nibiru.fi/docs/dev/x/)-specific documentation ## 💬 — Community -If you have questions or concerns, feel free to connect with a developer or community member in the [Nibiru discord][social-discord]. We also have active communities on Twitter and Telegram. +If you have questions or concerns, feel free to connect with a developer or community member in the [Nibiru Discord][social-discord]. We also have active communities on [Twitter][social-twitter] and [Telegram][social-telegram].