Skip to content

Commit 0e709ed

Browse files
committed
chore: add ignite "R" mark
1 parent 40af7a2 commit 0e709ed

35 files changed

Lines changed: 278 additions & 278 deletions

docs/docs.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ package docs
22

33
import "embed"
44

5-
// Docs are Ignite CLI docs.
5+
// Docs are IGNITE® CLI docs.
66
//
77
//go:embed docs
88
var Docs embed.FS

docs/docs/01-welcome/01-index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ slug: /welcome
44

55
import ProjectsTable from '@site/src/components/ProjectsTable';
66

7-
# Introduction to Ignite CLI: Your Gateway to Blockchain Innovation
7+
# Introduction to IGNITE® CLI: Your Gateway to Blockchain Innovation
88

9-
[Ignite CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, Ignite CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts.
10-
Beyond these, Ignite has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions.
9+
[IGNITE® CLI](https://github.com/ignite/cli) is a powerful tool that simplifies the journey of building, testing, and launching diverse blockchain applications. Developed on top of the [Cosmos SDK](https://docs.cosmos.network), the leading framework for blockchain technology, IGNITE® CLI is pivotal in streamlining the development process. It enables developers to focus on the unique aspects of their projects, from DeFi and NFTs to supply chain solutions and smart contracts.
10+
Beyond these, IGNITE® has been instrumental in a wide array of blockchain applications, ranging from VPNs and gaming platforms to blogs, oracle systems, and innovative consensus mechanisms. This demonstrates its versatility in supporting a broad spectrum of blockchain-based solutions.
1111

12-
## Key Features of Ignite CLI
12+
## Key Features of IGNITE® CLI
1313

14-
- **Simplified Blockchain Development:** Ignite CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient.
14+
- **Simplified Blockchain Development:** IGNITE® CLI, leveraging Cosmos SDK, makes building sovereign application-specific blockchains intuitive and efficient.
1515
- **Comprehensive Scaffolding:** Easily scaffold modules, messages, CRUD operations, IBC packets, and more, expediting the development of complex functionalities.
1616
- **Development with Live Reloading:** Start and test your blockchain node with real-time updates, enhancing your development workflow.
1717
- **Frontend Flexibility:** Utilize pre-built templates for Vue.js, React, Typescript or Go, catering to diverse frontend development needs.
1818
- **Inter-Blockchain Communication (IBC):** Seamlessly connect and interact with other blockchains using an integrated IBC relayer, a key feature of the Cosmos SDK.
1919
- **CometBFT Integration:** Built with the CometBFT consensus engine (formerly Tendermint), ensuring robust consensus mechanisms in your blockchain solutions.
20-
- **Cross-Domain Applications:** Ignite is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes).
20+
- **Cross-Domain Applications:** IGNITE® is perfectly suited for developing a diverse array of use cases across various sectors. These include DeFi, NFTs, supply chain management, smart contracts (both EVM and WASM), and decentralized exchanges (DEXes).
2121

2222
## Embracing the Cosmos Ecosystem
2323

24-
Ignite CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK.
24+
IGNITE® CLI is your entry point into the vibrant Cosmos ecosystem, a hub of innovation where you can explore a range of applications, from wallets and explorers to smart contracts and DEXes, all powered by CometBFT and the Cosmos SDK.
2525
This ecosystem is home to over [$100 billion worth of blockchain projects](https://cosmos.network/ecosystem/tokens/), showcasing the scalability and versatility of the technologies at play.
2626

2727
## Projects using Tendermint and Cosmos SDK
@@ -30,7 +30,7 @@ Many projects already showcase the Tendermint BFT consensus engine and the Cosmo
3030
the [Cosmos ecosystem](https://cosmos.network/ecosystem/apps) to discover a wide variety of apps, blockchains, wallets,
3131
and explorers that are built in the Cosmos ecosystem.
3232

33-
## Projects building with Ignite CLI
33+
## Projects building with IGNITE® CLI
3434

3535
<ProjectsTable data={[
3636
{ name: "Stride Labs", logo: "img/logo/stride.svg"},

docs/docs/01-welcome/02-install.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
---
22
sidebar_position: 1
3-
description: Steps to install Ignite CLI on your local computer.
3+
description: Steps to install IGNITE® CLI on your local computer.
44
---
55

6-
# Install Ignite CLI
6+
# Install IGNITE® CLI
77

8-
You can run [Ignite CLI](https://github.com/ignite/cli) in a web-based IDE or you can install Ignite CLI on your local computer.
8+
You can run [IGNITE® CLI](https://github.com/ignite/cli) in a web-based IDE or you can install IGNITE® CLI on your local computer.
99

1010
## Prerequisites
1111

12-
Be sure you have met the prerequisites before you install and use Ignite CLI.
12+
Be sure you have met the prerequisites before you install and use IGNITE® CLI.
1313

1414
### Operating systems
1515

16-
Ignite CLI is supported for the following operating systems:
16+
IGNITE® CLI is supported for the following operating systems:
1717

1818
- GNU/Linux
1919
- macOS
2020
- Windows Subsystem for Linux (WSL)
2121

2222
### Go
2323

24-
Ignite CLI is written in the Go programming language. To use Ignite CLI on a local system:
24+
IGNITE® CLI is written in the Go programming language. To use IGNITE® CLI on a local system:
2525

2626
- Install [Go](https://golang.org/doc/install) (**version 1.24.1** or higher)
2727
- Ensure the Go environment variables are [set properly](https://golang.org/doc/gopath_code#GOPATH) on your system
2828

29-
## Verify your Ignite CLI version
29+
## Verify your IGNITE® CLI version
3030

31-
To verify the version of Ignite CLI you have installed, run the following command:
31+
To verify the version of IGNITE® CLI you have installed, run the following command:
3232

3333
```bash
3434
ignite version
3535
```
3636

37-
## Installing Ignite CLI
37+
## Installing IGNITE® CLI
3838

39-
To install the latest version of Ignite use [HomeBrew](https://formulae.brew.sh/formula/ignite) on macOS and GNU/Linux:
39+
To install the latest version of IGNITE® use [HomeBrew](https://formulae.brew.sh/formula/ignite) on macOS and GNU/Linux:
4040

4141
```sh
4242
brew install ignite
@@ -53,7 +53,7 @@ curl https://get.ignite.com/cli! | bash
5353
This command invokes `curl` to download the installation script and pipes the output to `bash` to perform the
5454
installation. The `ignite` binary is installed in `/usr/local/bin`.
5555

56-
Ignite CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because
56+
IGNITE® CLI installation requires write permission to the `/usr/local/bin/` directory. If the installation fails because
5757
you do not have write permission to `/usr/local/bin/`, run the following command:
5858

5959
```bash
@@ -83,18 +83,18 @@ sudo curl https://get.ignite.com/cli | sudo bash
8383
To learn more or customize the installation process, see the [installer docs](https://github.com/ignite/installer) on
8484
GitHub.
8585

86-
## Upgrading your Ignite CLI installation {#upgrade}
86+
## Upgrading your IGNITE® CLI installation {#upgrade}
8787

88-
Before you install a new version of Ignite CLI, remove all existing Ignite CLI installations.
88+
Before you install a new version of IGNITE® CLI, remove all existing IGNITE® CLI installations.
8989

90-
To remove the current Ignite CLI installation:
90+
To remove the current IGNITE® CLI installation:
9191

9292
1. On your terminal window, press `Ctrl+C` to stop the chain that you started with `ignite chain serve`.
93-
2. Remove the Ignite CLI binary with `rm $(which ignite)`.
93+
2. Remove the IGNITE® CLI binary with `rm $(which ignite)`.
9494
Depending on your user permissions, run the command with or without `sudo`.
9595
3. Repeat this step until all `ignite` installations are removed from your system.
9696

97-
After all existing Ignite CLI installations are removed, follow the [Installing Ignite CLI](#installing-ignite-cli)
97+
After all existing IGNITE® CLI installations are removed, follow the [Installing IGNITE® CLI](#installing-ignite-cli)
9898
instructions.
9999

100100
For details on version features and changes, see
@@ -113,7 +113,7 @@ cd cli && make install
113113
## Summary
114114

115115
- Verify the prerequisites.
116-
- To set up a local development environment, install Ignite CLI locally on your computer.
117-
- Install Ignite CLI by fetching the binary using cURL or by building from source.
116+
- To set up a local development environment, install IGNITE® CLI locally on your computer.
117+
- Install IGNITE® CLI by fetching the binary using cURL or by building from source.
118118
- The latest version is installed by default. You can install previous versions of the precompiled `ignite` binary.
119119
- Stop the chain and remove existing versions before installing a new version.

docs/docs/02-guide/02-introduction.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ sidebar_position: 2
44

55
# Introduction
66

7-
In this guide, we will be using Ignite CLI to create a new blockchain. Ignite
7+
In this guide, we will be using IGNITE® CLI to create a new blockchain. IGNITE®
88
CLI is a command line interface that allows users to quickly and easily create
9-
blockchain networks. By using Ignite CLI, we can quickly create a new blockchain
9+
blockchain networks. By using IGNITE® CLI, we can quickly create a new blockchain
1010
without having to manually set up all the necessary components.
1111

12-
Once we have created our blockchain with Ignite CLI, we will take a look at the
12+
Once we have created our blockchain with IGNITE® CLI, we will take a look at the
1313
directory structure and files that were created. This will give us an
1414
understanding of how the blockchain is organized and how the different
1515
components of the blockchain interact with each other.
1616

1717
By the end of this guide, you will have a basic understanding of how to use
18-
Ignite CLI to create a new blockchain, and you will have a high-level
18+
IGNITE® CLI to create a new blockchain, and you will have a high-level
1919
understanding of the directory structure and files that make up a blockchain.
2020
This knowledge will be useful as you continue to explore the world of blockchain
2121
development.
2222

2323
If you are looking for more tutorials and hands-on experience, check out our tutorials website:
2424

25-
[Ignite Tutorials](https://tutorials.ignite.com)
25+
[IGNITE® Tutorials](https://tutorials.ignite.com)
2626

2727
## Creating a new blockchain
2828

29-
To create a new blockchain project with Ignite, you will need to run the
29+
To create a new blockchain project with IGNITE®, you will need to run the
3030
following command:
3131

3232
```
@@ -49,15 +49,15 @@ the chain's configuration, application logic, and tests, among others. It
4949
provides a starting point for developers to quickly set up a new Cosmos SDK
5050
blockchain and build their desired functionality on top of it.
5151

52-
By default, Ignite creates a new empty custom module with the same name as the
52+
By default, IGNITE® creates a new empty custom module with the same name as the
5353
blockchain being created (in this case, `example`) in the `x/` directory. This
5454
module doesn't have any functionality by itself, but can serve as a starting
5555
point for building out the features of your application. If you don't want to
5656
create this module, you can use the `--no-module` flag to skip it.
5757

5858
## Directory structure
5959

60-
In order to understand what the Ignite CLI has generated for your project, you
60+
In order to understand what the IGNITE® CLI has generated for your project, you
6161
can inspect the contents of the `example/` directory.
6262

6363
The `app/` directory contains the files that connect the different parts of the
@@ -145,7 +145,7 @@ the code can be reflected in the running blockchain without having to restart
145145
the node. This allows for faster development and testing of the blockchain.
146146

147147
**Congratulations!** 🥳 You have successfully created a brand-new Cosmos blockchain
148-
using the Ignite CLI. This blockchain uses the delegated proof of stake (DPoS)
148+
using the IGNITE® CLI. This blockchain uses the delegated proof of stake (DPoS)
149149
consensus algorithm, and comes with a set of standard modules for token
150150
transfers, governance, and inflation. Now that you have a basic understanding of
151151
your Cosmos blockchain, it's time to start building custom functionality. In the

docs/docs/02-guide/03-hello-world.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ description: Build your first blockchain and your first Cosmos SDK query.
33
title: Hello World
44
---
55

6-
# "Hello world!" Blockchain Tutorial with Ignite CLI
6+
# "Hello world!" Blockchain Tutorial with IGNITE® CLI
77

88
**Introduction**
99

10-
In this tutorial, you'll build a simple blockchain using Ignite CLI that responds to a custom query with `Hello %s!`, where `%s` is a name passed in the query.
10+
In this tutorial, you'll build a simple blockchain using IGNITE® CLI that responds to a custom query with `Hello %s!`, where `%s` is a name passed in the query.
1111
This will enhance your understanding of creating custom queries in a Cosmos SDK blockchain.
1212

1313
## Setup and Scaffold
@@ -93,4 +93,4 @@ Expect a response: `Hello world!`
9393

9494
## Conclusion
9595

96-
Congratulations! 🎉 You've successfully created a blockchain module with a custom query using Ignite CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of Ignite CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.
96+
Congratulations! 🎉 You've successfully created a blockchain module with a custom query using IGNITE® CLI. Through this tutorial, you've learned how to scaffold a chain, add a custom query, and modify the logic for personalized responses. This experience illustrates the power of IGNITE® CLI in streamlining blockchain development and the importance of understanding the underlying code for customization.

docs/docs/02-guide/04-ibc.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ between blockchains with the Cosmos SDK.
1515
**You will learn how to**
1616

1717
- Use IBC to create and send packets between blockchains.
18-
- Navigate between blockchains using the Cosmos SDK and the Ignite CLI Relayer.
18+
- Navigate between blockchains using the Cosmos SDK and the IGNITE® CLI Relayer.
1919
- Create a basic blog post and save the post on another blockchain.
2020

2121
## What is IBC?
@@ -33,7 +33,7 @@ blockchain.
3333

3434
The IBC relayer lets you connect between sets of IBC-enabled chains. This
3535
tutorial teaches you how to create two blockchains and then start and use the
36-
relayer with Ignite CLI to connect two blockchains.
36+
relayer with IGNITE® CLI to connect two blockchains.
3737

3838
This tutorial covers essentials like modules, IBC packets, relayer, and the
3939
lifecycle of packets routed through IBC.
@@ -68,7 +68,7 @@ post is saved on both blockchains.
6868

6969
## Build your blockchain app
7070

71-
Use Ignite CLI to scaffold the blockchain app and the blog module.
71+
Use IGNITE® CLI to scaffold the blockchain app and the blog module.
7272

7373
### Build a new blockchain
7474

@@ -84,7 +84,7 @@ directory contains a working blockchain app.
8484

8585
### Scaffold the blog module inside your blockchain
8686

87-
Next, use Ignite CLI to scaffold a blog module with IBC capabilities. The blog
87+
Next, use IGNITE® CLI to scaffold a blog module with IBC capabilities. The blog
8888
module contains the logic for creating blog posts and routing them through IBC
8989
to the second blockchain.
9090

@@ -129,7 +129,7 @@ ignite scaffold list timeoutPost title chain creator --no-message --module blog
129129
The scaffolded code includes proto files for defining data structures, messages,
130130
messages handlers, keepers for modifying the state, and CLI commands.
131131

132-
### Ignite CLI Scaffold List Command Overview
132+
### IGNITE® CLI Scaffold List Command Overview
133133

134134
```
135135
ignite scaffold list [typeName] [field1] [field2] ... [flags]
@@ -143,7 +143,7 @@ The next arguments define the fields that are associated with the type. For the
143143
blog app, you created `title`, `content`, `postID`, and `chain` fields.
144144

145145
The `--module` flag defines which module the new transaction type is added to.
146-
This optional flag lets you manage multiple modules within your Ignite CLI app.
146+
This optional flag lets you manage multiple modules within your IGNITE® CLI app.
147147
When the flag is not present, the type is scaffolded in the module that matches
148148
the name of the repo.
149149

@@ -295,7 +295,7 @@ created the message, use an identifier in the following format:
295295

296296
`<portID>-<channelID>-<creatorAddress>`
297297

298-
Finally, the Ignite CLI-generated AppendPost function returns the ID of the new
298+
Finally, the IGNITE® CLI-generated AppendPost function returns the ID of the new
299299
appended post. You can return this value to the source chain through
300300
acknowledgment.
301301

@@ -506,7 +506,7 @@ ignite app install -g github.com/ignite/apps/hermes
506506
```
507507

508508
If you previously used the relayer, follow these steps to remove exiting relayer
509-
and Ignite CLI configurations:
509+
and IGNITE® CLI configurations:
510510

511511
- Stop your blockchains and delete previous configuration files:
512512

@@ -664,6 +664,6 @@ Here's what you accomplished in this tutorial:
664664

665665
- Built two Hello blockchain apps as IBC modules
666666
- Modified the generated code to add CRUD action logic
667-
- Configured and used the Ignite CLI relayer to connect two blockchains with
667+
- Configured and used the IGNITE® CLI relayer to connect two blockchains with
668668
each other
669669
- Transferred IBC packets from one blockchain to another

docs/docs/02-guide/05-debug.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Debugging your Cosmos SDK blockchain
44

55
# Debugging a chain
66

7-
Ignite chain debug command can help you find issues during development. It uses
7+
IGNITE® chain debug command can help you find issues during development. It uses
88
[Delve](https://github.com/go-delve/delve) debugger which enables you to
99
interact with your blockchain app by controlling the execution of the process,
1010
evaluating variables, and providing information of thread / goroutine state, CPU
@@ -138,7 +138,7 @@ Connect to Server" and enter the debug host address and then the port number.
138138

139139
## Example: Debugging a Blockchain App
140140

141-
In this short example we will be using Ignite CLI to create a new blockchain and
141+
In this short example we will be using IGNITE® CLI to create a new blockchain and
142142
a query to be able to trigger a debugging breakpoint when the query is called.
143143

144144
Create a new blockchain:

0 commit comments

Comments
 (0)