Skip to content

Commit e7ed442

Browse files
docs: Fix stale README
1 parent fb37c6f commit e7ed442

File tree

1 file changed

+12
-33
lines changed

1 file changed

+12
-33
lines changed

README.md

Lines changed: 12 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,18 @@
66
[![GitHub][license-badge]](https://github.com/NibiruChain/nibiru/blob/main/LICENSE.md)
77
[![Discord Badge](https://dcbadge.vercel.app/api/server/nibirufi?style=flat)](https://discord.gg/nibirufi)
88

9-
**Nibiru Chain** is a breakthrough smart contract platform providing superior throughput, reduced latency, and improved security, all driven by Web Assembly (Wasm) smart contracts.
10-
11-
- [Nibiru Chain](#nibiru-chain)
12-
- [⚙️ — Documentation](#️--documentation)
13-
- [💬 — Community](#--community)
14-
- [🧱 — Components of Nibiru](#--components-of-nibiru)
15-
- [⛓️ — Building: `make` commands](#️--building-make-commands)
16-
- [Nibid CLI](#nibid-cli)
17-
- [Running a Local Node](#running-a-local-node)
18-
- [Generate the protobufs](#generate-the-protobufs)
19-
- [Linter](#linter)
20-
- [Multiple Nodes](#multiple-nodes)
21-
- [License](#license)
9+
**Nibiru Chain** is a breakthrough Layer 1 blockchain and smart contract ecosystem providing superior throughput, improved security, and a high-performance EVM execution layer. Nibiru aims to be the most developer-friendly and user-friendly smart contract ecosystem, leading the charge toward mainstream Web3 adoption by innovating at each layer of the stack: dApp development, scalable blockchain data indexing, consensus optimizations, a comprehensive developer toolkit, and composability across multiple VMs.
2210

2311
## ⚙️ — Documentation
2412

2513
- [Docs | Nibiru Chain](https://nibiru.fi/docs/): Conceptual and technical documentation can be found here.
2614
- [Complete Golang reference docs](https://pkg.go.dev/github.com/NibiruChain/nibiru): (`pkg.go.dev`) For the blockchain implementation .
27-
- ["X Module"](https://nibiru.fi/docs/dev/x/)-specific documentation
15+
- [Nibiru Modules](https://nibiru.fi/docs/dev/x/): Module-specific documentation
2816

2917
## 💬 — Community
3018

3119
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].
3220

33-
<!-- Markdown versions of the social badges
34-
[![description][discord-badge]][social-discord]
35-
[![description][twitter-badge]][social-twitter]
36-
[![description][telegram-badge]][social-telegram]
37-
-->
38-
3921
<p style="display: flex; gap: 24px; justify-content: center; text-align:center">
4022
<a href="https://discord.gg/nibiruchain"><img src="https://img.shields.io/badge/Discord-7289DA?&logo=discord&logoColor=white" alt="Discord" height="22"/></a>
4123
<a href="https://twitter.com/NibiruChain"><img src="https://img.shields.io/badge/Twitter-1DA1F2?&logo=twitter&logoColor=white" alt="Tweet" height="22"/></a>
@@ -44,26 +26,23 @@ If you have questions or concerns, feel free to connect with a developer or comm
4426

4527
## 🧱 — Components of Nibiru
4628

47-
- **CosmWasm Smart Contracts**: Rust-based, Wasm smart contracts built enhanced security, performance, and interoperability. See our [CosmWasm sandbox monorepo (cw-nibiru)](https://github.com/NibiruChain/cw-nibiru/tree/main) for the protocol's core smart contracts.
48-
- **Nibi-Oracle**: 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.
49-
- **Nibi-Swap**: An automated market maker protocol for multichain assets. This application gives users access to swaps, pools, and bonded liquidity gauges.
50-
5129
| Module | Description |
5230
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
53-
| [wasm][code-x-wasm] | Implements the execution environment for [WebAssembly (WASM) smart contracts](https://nibiru.fi/docs/wasm/). |
54-
| [devgas][code-x-devgas] | The `devgas` module of Nibiru Chain shares contract execution fees with smart contract developers. This aims to increase the adoption of Nibiru by offering CosmWasm smart contract developers a direct source of income based on usage. |
55-
| [epochs][code-x-epochs] | The `epochs` module allows other modules to set hooks to be called to execute code automatically on a period basis. For example, "once a week, starting at UTC-time = x". `epochs` creates a generalized epoch interface. |
56-
| [inflation][code-x-inflation] | Implements the [tokenomics](https://nibiru.fi/docs/learn/tokenomics.html) for Nibiru. |
57-
| [common][code-x-common] | Holds helper and utility functions to be utilized by other `x/` modules. |
58-
| [oracle][code-x-oracle] | Handles the posting of an up-to-date and accurate feed of exchange rates from the validators. |
59-
| [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. |
31+
| [Wasm][code-x-wasm] | Implements the execution environment for WebAssembly (WASM) smart contracts. CosmWasm smart contracts are Rust-based, Wasm smart contracts built for enhanced security, performance, and interoperability. See our [CosmWasm sandbox monorepo (cw-nibiru)](https://github.com/NibiruChain/cw-nibiru/tree/main) for the protocol's core smart contracts. |
32+
| [EVM][code-x-evm] | Implements Nibiru EVM, which manages an Ethereum Virtual Machine (EVM) state database and enables the execution of Ethereum smart contracts. Nibiru EVM is an extension of "[geth](https://github.com/ethereum/go-ethereum)" along with "web3" and "eth" JSON-RPC methods. |
33+
| [Devgas][code-x-devgas] | The `devgas` module of Nibiru Chain shares contract execution fees with smart contract developers. This aims to increase the adoption of Nibiru by offering CosmWasm smart contract developers a direct source of income based on usage. |
34+
| [Epochs][code-x-epochs] | The `epochs` module allows other modules to set hooks to be called to execute code automatically on a period basis. For example, "once a week, starting at UTC-time = x". `epochs` creates a generalized epoch interface. |
35+
| [Inflation][code-x-inflation] | Implements the [tokenomics](https://nibiru.fi/docs/learn/tokenomics.html) for Nibiru. |
36+
| [Oracle][code-x-oracle] | 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) protocol. Nibi-Oracle handles the voting process for validators that act as oracles by updating data feeds. |
37+
| [Common][code-x-common] | Helper and utility functions to be utilized by other `x/` modules. |
6038

6139
[code-x-common]: https://github.com/NibiruChain/nibiru/tree/main/x/common
6240
[code-x-devgas]: https://nibiru.fi/docs/dev/x/nibiru-chain/devgas.html
6341
[code-x-epochs]: https://github.com/NibiruChain/nibiru/tree/main/x/epochs
6442
[code-x-inflation]: https://github.com/NibiruChain/nibiru/tree/main/x/inflation
6543
[code-x-oracle]: https://github.com/NibiruChain/nibiru/tree/main/x/oracle
66-
[code-x-spot]: https://github.com/NibiruChain/nibiru/tree/main/x/spot
44+
[code-x-wasm]: https://nibiru.fi/docs/wasm/
45+
[code-x-evm]: https://github.com/NibiruChain/nibiru/tree/main/x/evm
6746

6847
Nibiru is built with the [Cosmos-SDK][cosmos-sdk-repo] on [Tendermint Core](https://tendermint.com/core/) consensus and communicates with other blockchain chains using the [Inter-Blockchain Communication (IBC)](https://github.com/cosmos/ibc) protocol.
6948

@@ -126,7 +105,7 @@ make localnet-start
126105

127106
## License
128107

129-
Licensed under the [MIT License](./LICENSE.md).
108+
Unless a file notes otherwise, it will fall under the [MIT License](./LICENSE.md).
130109

131110
[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
132111
[cosmos-sdk-repo]: https://github.com/cosmos/cosmos-sdk

0 commit comments

Comments
 (0)