Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pyramation committed Apr 6, 2024
1 parent 13cf568 commit 81c0717
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Set up a modern Cosmos app by running one command ⚛️
- [Overview](#overview)
- [Education & Resources](#education--resources)
- [Creating an App](#creating-an-app)
- [Options](#options)
- [Examples](#examples)
- [Options](#options)
- [Development](#development)

https://user-images.githubusercontent.com/545047/192061992-f0e1106d-f4b2-4879-ab0a-896f22ee4f49.mp4
Expand Down Expand Up @@ -110,18 +110,6 @@ npm init cosmos-app
yarn create cosmos-app
```

## Options

| Argument | Description | Default |
|----------------------|------------------------------------------------|------------|
| `--repo` | Set custom repository for cca templates | None |
| `--install` | Automatically install dependencies | `true` |
| `--printCmd` | Print the command to run after setup | `true` |
| `-n`, `--name` | Provide a project name | None |
| `-e`, `--example` | Provide an example name | None |
| `-t`, `--template` | Define the template to use | None |
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |

## Examples

The `create-cosmos-app` tool provides a range of examples to help you understand and test various features and integrations. By executing the examples, you can quickly see how to implement specific functionalities in your Cosmos app.
Expand Down Expand Up @@ -241,6 +229,18 @@ Incorporate NFT functionalities into your Stargaze app using [stargazejs](https:
cca --name nft-example --example nft
```

## Options

| Argument | Description | Default |
|----------------------|------------------------------------------------|------------|
| `--repo` | Set custom repository for cca templates | None |
| `--install` | Automatically install dependencies | `true` |
| `--printCmd` | Print the command to run after setup | `true` |
| `-n`, `--name` | Provide a project name | None |
| `-e`, `--example` | Provide an example name | None |
| `-t`, `--template` | Define the template to use | None |
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |

## Development

Because the nature of how template boilerplates are generated, we generate `yarn.lock` files inside of nested packages so we can fix versions to avoid non-deterministic installations.
Expand Down
26 changes: 13 additions & 13 deletions packages/create-cosmos-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Set up a modern Cosmos app by running one command ⚛️
- [Overview](#overview)
- [Education & Resources](#education--resources)
- [Creating an App](#creating-an-app)
- [Options](#options)
- [Examples](#examples)
- [Options](#options)
- [Development](#development)

https://user-images.githubusercontent.com/545047/192061992-f0e1106d-f4b2-4879-ab0a-896f22ee4f49.mp4
Expand Down Expand Up @@ -110,18 +110,6 @@ npm init cosmos-app
yarn create cosmos-app
```

## Options

| Argument | Description | Default |
|----------------------|------------------------------------------------|------------|
| `--repo` | Set custom repository for cca templates | None |
| `--install` | Automatically install dependencies | `true` |
| `--printCmd` | Print the command to run after setup | `true` |
| `-n`, `--name` | Provide a project name | None |
| `-e`, `--example` | Provide an example name | None |
| `-t`, `--template` | Define the template to use | None |
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |

## Examples

The `create-cosmos-app` tool provides a range of examples to help you understand and test various features and integrations. By executing the examples, you can quickly see how to implement specific functionalities in your Cosmos app.
Expand Down Expand Up @@ -241,6 +229,18 @@ Incorporate NFT functionalities into your Stargaze app using [stargazejs](https:
cca --name nft-example --example nft
```

## Options

| Argument | Description | Default |
|----------------------|------------------------------------------------|------------|
| `--repo` | Set custom repository for cca templates | None |
| `--install` | Automatically install dependencies | `true` |
| `--printCmd` | Print the command to run after setup | `true` |
| `-n`, `--name` | Provide a project name | None |
| `-e`, `--example` | Provide an example name | None |
| `-t`, `--template` | Define the template to use | None |
| `-b`, `--fromBranch` | Specify the branch to use for cloning | None |

## Development

Because the nature of how template boilerplates are generated, we generate `yarn.lock` files inside of nested packages so we can fix versions to avoid non-deterministic installations.
Expand Down

0 comments on commit 81c0717

Please sign in to comment.