Skip to content

Commit 2b8db92

Browse files
sdqedesdqede
authored
Merge pull request #243 from hyperweb-io/update-readme
modified new version notice
2 parents dccc256 + d2c9dff commit 2b8db92

File tree

50 files changed

+680
-710
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+680
-710
lines changed

‎README.md‎

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
> **⚠️ DEPRECATION NOTICE**
2-
>
3-
> **This package is deprecated and no longer maintained.**
4-
>
5-
> Please use [**create-interchain-app**](https://github.com/hyperweb-io/create-interchain-app) instead, which provides the latest features and improvements for building Interchain applications.
1+
> **⚠️ UPGRADE TO 2.0**
2+
>
3+
> **Create Cosmos App 2.0 is here!** This package has been superseded by the new version.
4+
>
5+
> Please upgrade to [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app) (Create Cosmos App 2.0), featuring enhanced capabilities and expanded Interchain ecosystem support.
66
77
# create-cosmos-app
88

@@ -27,7 +27,6 @@ Set up a modern Cosmos app by running one command ⚛️
2727

2828
https://user-images.githubusercontent.com/545047/192061992-f0e1106d-f4b2-4879-ab0a-896f22ee4f49.mp4
2929

30-
3130
## Overview
3231

3332
First, install `create-cosmos-app` globally using npm:
@@ -146,7 +145,6 @@ This command will generate a new project configured with the selected example, a
146145

147146
Initiate and manage staking operations directly within your application, allowing users to stake tokens securely and efficiently.
148147

149-
150148
```
151149
cca --name stake-example --example stake-tokens
152150
```
@@ -237,15 +235,15 @@ cca --name nft-example --example nft
237235

238236
## Options
239237

240-
| Argument | Description | Default |
241-
|----------------------|------------------------------------------------|------------|
242-
| `--repo` | Set custom repository for cca templates | None |
243-
| `--install` | Automatically install dependencies | `true` |
244-
| `--printCmd` | Print the command to run after setup | `true` |
245-
| `-n`, `--name` | Provide a project name | None |
246-
| `-e`, `--example` | Provide an example name | None |
247-
| `-t`, `--template` | Define the template to use | None |
248-
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |
238+
| Argument | Description | Default |
239+
| -------------------- | --------------------------------------- | ------- |
240+
| `--repo` | Set custom repository for cca templates | None |
241+
| `--install` | Automatically install dependencies | `true` |
242+
| `--printCmd` | Print the command to run after setup | `true` |
243+
| `-n`, `--name` | Provide a project name | None |
244+
| `-e`, `--example` | Provide an example name | None |
245+
| `-t`, `--template` | Define the template to use | None |
246+
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |
249247

250248
## Development
251249

@@ -265,21 +263,21 @@ When you need to remove/generate locks for all nested packages, simply run `yarn
265263
yarn locks
266264
```
267265

268-
## Interchain JavaScript Stack
266+
## Interchain JavaScript Stack
269267

270268
A unified toolkit for building applications and smart contracts in the Interchain ecosystem ⚛️
271269

272-
| Category | Tools | Description |
273-
|----------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
274-
| **Chain Information** | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
275-
| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
276-
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
277-
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
278-
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
279-
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
280-
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
281-
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
282-
| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen) | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
270+
| Category | Tools | Description |
271+
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
272+
| **Chain Information** | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
273+
| **Wallet Connectors** | [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
274+
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
275+
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
276+
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
277+
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
278+
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
279+
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
280+
| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen) | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
283281

284282
## Credits
285283

‎boilerplates/lerna-module/README.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
> **⚠️ DEPRECATION NOTICE**
2-
>
3-
> **This package is deprecated and no longer maintained.**
4-
>
5-
> Please use [**create-interchain-app**](https://github.com/hyperweb-io/create-interchain-app) instead, which provides the latest features and improvements for building Interchain applications.
1+
> **⚠️ UPGRADE TO 2.0**
2+
>
3+
> **Create Cosmos App 2.0 is here!** This package has been superseded by the new version.
4+
>
5+
> Please upgrade to [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app) (Create Cosmos App 2.0), featuring enhanced capabilities and expanded Interchain ecosystem support.
66
7-
# __MODULENAME__
7+
# **MODULENAME**
88

99
<p align="center">
1010
<img src="https://user-images.githubusercontent.com/545047/188804067-28e67e5e-0214-4449-ab04-2e0c564a6885.svg" width="80"><br />
@@ -16,9 +16,10 @@
1616
```sh
1717
npm install __MODULENAME__
1818
```
19+
1920
## Table of contents
2021

21-
- [__MODULENAME__](#__MODULENAME__)
22+
- [**MODULENAME**](#__MODULENAME__)
2223
- [Install](#install)
2324
- [Table of contents](#table-of-contents)
2425
- [Developing](#developing)
@@ -42,27 +43,26 @@ yarn
4243
yarn build:dev
4344
```
4445

45-
## Interchain JavaScript Stack
46+
## Interchain JavaScript Stack
4647

4748
A unified toolkit for building applications and smart contracts in the Interchain ecosystem ⚛️
4849

49-
| Category | Tools | Description |
50-
|----------------------|------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
51-
| **Chain Information** | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
52-
| **Wallet Connectors**| [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
53-
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
54-
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
55-
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
56-
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
57-
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
58-
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
59-
| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen) | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
50+
| Category | Tools | Description |
51+
| ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
52+
| **Chain Information** | [**Chain Registry**](https://github.com/hyperweb-io/chain-registry), [**Utils**](https://www.npmjs.com/package/@chain-registry/utils), [**Client**](https://www.npmjs.com/package/@chain-registry/client) | Everything from token symbols, logos, and IBC denominations for all assets you want to support in your application. |
53+
| **Wallet Connectors** | [**Interchain Kit**](https://github.com/hyperweb-io/interchain-kit)<sup>beta</sup>, [**Cosmos Kit**](https://github.com/hyperweb-io/cosmos-kit) | Experience the convenience of connecting with a variety of web3 wallets through a single, streamlined interface. |
54+
| **Signing Clients** | [**InterchainJS**](https://github.com/hyperweb-io/interchainjs)<sup>beta</sup>, [**CosmJS**](https://github.com/cosmos/cosmjs) | A single, universal signing interface for any network |
55+
| **SDK Clients** | [**Telescope**](https://github.com/hyperweb-io/telescope) | Your Frontend Companion for Building with TypeScript with Cosmos SDK Modules. |
56+
| **Starter Kits** | [**Create Interchain App**](https://github.com/hyperweb-io/create-interchain-app)<sup>beta</sup>, [**Create Cosmos App**](https://github.com/hyperweb-io/create-cosmos-app) | Set up a modern Interchain app by running one command. |
57+
| **UI Kits** | [**Interchain UI**](https://github.com/hyperweb-io/interchain-ui) | The Interchain Design System, empowering developers with a flexible, easy-to-use UI kit. |
58+
| **Testing Frameworks** | [**Starship**](https://github.com/hyperweb-io/starship) | Unified Testing and Development for the Interchain. |
59+
| **TypeScript Smart Contracts** | [**Create Hyperweb App**](https://github.com/hyperweb-io/create-hyperweb-app) | Build and deploy full-stack blockchain applications with TypeScript |
60+
| **CosmWasm Contracts** | [**CosmWasm TS Codegen**](https://github.com/CosmWasm/ts-codegen) | Convert your CosmWasm smart contracts into dev-friendly TypeScript classes. |
6061

6162
## Credits
6263

6364
🛠 Built by Hyperweb (formerly Cosmology) — if you like our tools, please checkout and contribute to [our github ⚛️](https://github.com/hyperweb-io)
6465

65-
6666
## Disclaimer
6767

6868
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED “AS IS”, AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.

0 commit comments

Comments
 (0)