Skip to content

Commit 7903b81

Browse files
committed
docs: update README.md to reflect CLI tool changes
Simplify the README.md to focus on the CLI tool's core functionality. Remove outdated information about visual editor, database options, and deployment tools, as they are no longer relevant. Update installation instructions to align with the latest CLI usage.
1 parent 2ae1ff0 commit 7903b81

1 file changed

Lines changed: 9 additions & 45 deletions

File tree

README.md

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,16 @@
1-
# Create PNStack
1+
# create-pnstack
22

3-
This project aims to create PNStack, a platform for building full-stack applications quickly.
3+
A command-line interface (CLI) tool for scaffolding PNStack projects.
44

55
## Features
66

7-
- Scaffolding tools to generate project templates for various frameworks like React, Vue, Angular etc.
8-
- CLI to quickly create projects from templates
9-
- Visual editor to build UIs without code
10-
- Integrated database options like SQL, MongoDB, GraphQL etc.
11-
- Built-in authentication and authorization
12-
- Deployment tools for hosting on various platforms
7+
- Create new PNStack projects with a single command
8+
- Support for TypeScript and JavaScript templates
9+
- Built-in React + SWC configuration
10+
- Automated project setup and dependencies installation
1311

14-
## Getting Started
15-
16-
To use Create PNStack:
17-
18-
1. Install the CLI globally:
19-
20-
```bash
21-
npm install -g create-pnstack
22-
```
23-
24-
2. Run the CLI to create a new project:
12+
## Installation
2513

2614
```bash
27-
create-pnstack my-app
28-
```
29-
30-
3. Choose a template like React, Vue etc and answer prompts about features to scaffold the project.
31-
32-
4. `cd` into the project folder and run:
33-
34-
35-
5. Start building your app! Modify source files in `src/` and components in `components/`.
36-
37-
## Documentation
38-
39-
Full documentation is available at [pnstack.com/docs](https://pnstack.com/docs).
40-
41-
- [Project Structure](https://pnstack.com/docs/project-structure)
42-
- [CLI Usage](https://pnstack.com/docs/cli)
43-
- [Deployment Guide](https://pnstack.com/docs/deployment)
44-
- [Creating Templates](https://pnstack.com/docs/templates)
45-
46-
## Contributing
47-
48-
Pull requests are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
49-
50-
## License
51-
52-
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
15+
npm create pnstack@latest
16+
```

0 commit comments

Comments
 (0)