Skip to content
This repository was archived by the owner on Nov 10, 2025. It is now read-only.

Commit b8cf335

Browse files
committed
docs: improve README and remove strikethrough from coming soon templates
- Add installation section with npx and global install options - Add badges for npm downloads and Node.js version - Add "Why create-mn-app?" section highlighting key benefits - Add Contributing and Author sections - Remove strikethrough from coming soon templates (disabled property) - Keep "(Coming Soon)" text in gray for clarity
1 parent 85d3300 commit b8cf335

File tree

2 files changed

+33
-1
lines changed

2 files changed

+33
-1
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,37 @@
33
Scaffold Midnight Network applications.
44

55
[![npm version](https://img.shields.io/npm/v/create-mn-app.svg)](https://www.npmjs.com/package/create-mn-app)
6+
[![npm downloads](https://img.shields.io/npm/dw/create-mn-app.svg)](https://www.npmjs.com/package/create-mn-app)
67
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
8+
[![Node.js](https://img.shields.io/node/v/create-mn-app.svg)](https://nodejs.org/)
9+
10+
## Installation
11+
12+
**Recommended (no install needed):**
713

814
```bash
915
npx create-mn-app my-app
1016
cd my-app
1117
npm run setup
1218
```
1319

20+
**Or install globally:**
21+
22+
```bash
23+
npm i -g create-mn-app
24+
create-mn-app my-app
25+
```
26+
27+
> Using `npx` is recommended - it always runs the latest version without needing updates.
28+
29+
## Why create-mn-app?
30+
31+
- **Zero Configuration**: Start building immediately without complex setup
32+
- **Best Practices**: Pre-configured TypeScript, hot reloading, and project structure
33+
- **Production Ready**: Includes wallet generation, environment management, and deployment scripts
34+
- **Developer Experience**: Interactive prompts, health checks, and helpful error messages
35+
- **Stay Updated**: Built-in update notifier keeps you on the latest version
36+
1437
## Features
1538

1639
- Interactive project setup with template selection
@@ -132,6 +155,16 @@ docker stop <container-id>
132155

133156
Testnet faucet typically takes 2-5 minutes. The deploy script will auto-detect when funds arrive.
134157

158+
## Contributing
159+
160+
Contributions are welcome! Please feel free to submit a Pull Request.
161+
162+
1. Fork the repository
163+
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
164+
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
165+
4. Push to the branch (`git push origin feature/amazing-feature`)
166+
5. Open a Pull Request
167+
135168
## Links
136169

137170
- [Midnight Docs](https://docs.midnight.network)

src/create-app.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,6 @@ export async function createApp(
106106
: t.display,
107107
value: t.name,
108108
description: t.description,
109-
disabled: !t.available,
110109
}));
111110

112111
const response = await prompts({

0 commit comments

Comments
 (0)