Skip to content

Commit 9173013

Browse files
committed
docs: fix README formatting and code blocks
- Fix unclosed markdown code blocks - Properly format project structure tree with correct indentation - Fix Quick Start section header (### instead of #) - Clean up spacing and ensure proper markdown rendering
1 parent 4c2d097 commit 9173013

File tree

1 file changed

+16
-45
lines changed

1 file changed

+16
-45
lines changed

README.md

Lines changed: 16 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,10 @@ npx kitdot init my-polkadot-dapp
3333

3434
## Quick Start
3535

36-
# Quick start with default template
36+
### Quick start with default template
3737

38+
```bash
3839
kitdot install -y my-app
39-
4040
```
4141

4242
The CLI will guide you through setting up:
@@ -48,21 +48,19 @@ The CLI will guide you through setting up:
4848
## Project Structure
4949

5050
```
51-
5251
my-polkadot-dapp/
53-
├── contracts/ # Hardhat smart contracts (Solidity)
54-
│ ├── contracts/ # Smart contract source files
55-
│ ├── ignition/ # Hardhat Ignition deployment modules
56-
│ ├── test/ # Contract tests
57-
│ └── hardhat.config.ts # Hardhat configuration for Polkadot
58-
├── frontend/ # React frontend with Polkadot integration
59-
│ ├── src/ # React TypeScript source
60-
│ ├── src/generated.ts # Auto-generated contract types
61-
│ └── wagmi.config.ts # wagmi configuration for Polkadot
62-
├── AGENTS.md # AI development guide for LLMs
63-
└── README.md # Project-specific documentation
64-
65-
````
52+
├── contracts/ # Hardhat smart contracts (Solidity)
53+
│ ├── contracts/ # Smart contract source files
54+
│ ├── ignition/ # Hardhat Ignition deployment modules
55+
│ ├── test/ # Contract tests
56+
│ └── hardhat.config.ts # Hardhat configuration for Polkadot
57+
├── frontend/ # React frontend with Polkadot integration
58+
│ ├── src/ # React TypeScript source
59+
│ ├── src/generated.ts # Auto-generated contract types
60+
│ └── wagmi.config.ts # wagmi configuration for Polkadot
61+
├── AGENTS.md # AI development guide for LLMs
62+
└── README.md # Project-specific documentation
63+
```
6664

6765
## Commands
6866

@@ -79,7 +77,7 @@ kitdot tools check # Check tool status
7977
# Help
8078
kitdot --help # Show all available commands
8179
kitdot init --help # Show specific command help
82-
````
80+
```
8381

8482
> **Note**: Replace `kitdot` with `npx kitdot` if you haven't installed globally.
8583
@@ -111,33 +109,6 @@ npm run generate # Generate contract types from deployed c
111109
npm run dev # Start development server
112110
```
113111

114-
### 4. Environment Setup
115-
116-
```bash
117-
# Set up private key for contract deployment
118-
npx hardhat vars set PRIVATE_KEY # In contracts directory
119-
120-
# Get testnet tokens
121-
# Visit: https://faucet.polkadot.io/?parachain=1111
122-
```
123-
124-
## Technology Stack
125-
126-
### Smart Contracts
127-
128-
- **Hardhat** - Development environment with Polkadot support via `@parity/hardhat-polkadot`
129-
- **Solidity ^0.8.28** - Smart contract programming language (required version)
130-
- **Hardhat Ignition** - Modern deployment system with dependency management
131-
- **Polkadot Asset Hub** - Target network for smart contract deployment
132-
133-
### Frontend
134-
135-
- **React 18** - Modern UI library with TypeScript
136-
- **wagmi** - React hooks for Ethereum/Polkadot contract interaction
137-
- **Viem** - TypeScript interface for Ethereum-compatible chains
138-
- **Tailwind CSS** - Utility-first CSS framework with Tailwind UI components
139-
- **Vite** - Fast build tool and development server
140-
141112
## Templates
142113

143114
kitdot includes production-ready templates:
@@ -163,4 +134,4 @@ kitdot includes production-ready templates:
163134

164135
## License
165136

166-
MIT License - see [LICENSE](LICENSE) for details.
137+
MIT License - see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)