Skip to content

Commit 796379c

Browse files
authored
docs: add prerequisites and improve Development section in README (#277)
Add Node.js and pnpm version requirements, a link to CONTRIBUTING.md, and the dev:docs script to help new contributors get started faster.
1 parent 65c2dfc commit 796379c

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,33 @@ Looking for advanced features? Check out [Styleframe Pro](https://styleframe.dev
173173

174174
## Development
175175

176+
### Prerequisites
177+
178+
- [Node.js](https://nodejs.org/) v22.0.0 or higher
179+
- [pnpm](https://pnpm.io/) v10.7.1 or higher
180+
181+
### Getting Started
182+
176183
```bash
177184
# Clone the repository
178185
git clone https://github.com/styleframe-dev/styleframe.git
186+
cd styleframe
179187

180188
# Install dependencies
181189
pnpm install
182190

183191
# Run tests
184192
pnpm test
185193

186-
# Build
194+
# Build all packages
187195
pnpm build
196+
197+
# Start development server (docs + storybook)
198+
pnpm dev:docs
188199
```
189200

201+
See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines.
202+
190203
## License
191204

192205
Styleframe is [MIT licensed](https://github.com/styleframe-dev/styleframe/blob/main/LICENSE).

0 commit comments

Comments
 (0)