From 5d0d274832d37328895e80b8f2056bd580ad5275 Mon Sep 17 00:00:00 2001 From: Alex Grozav Date: Wed, 24 Jun 2026 06:55:02 +0300 Subject: [PATCH] docs: add prerequisites and improve Development section in README Add Node.js and pnpm version requirements, a link to CONTRIBUTING.md, and the dev:docs script to help new contributors get started faster. --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b2fdfdf..0790f99c 100644 --- a/README.md +++ b/README.md @@ -173,9 +173,17 @@ Looking for advanced features? Check out [Styleframe Pro](https://styleframe.dev ## Development +### Prerequisites + +- [Node.js](https://nodejs.org/) v22.0.0 or higher +- [pnpm](https://pnpm.io/) v10.7.1 or higher + +### Getting Started + ```bash # Clone the repository git clone https://github.com/styleframe-dev/styleframe.git +cd styleframe # Install dependencies pnpm install @@ -183,10 +191,15 @@ pnpm install # Run tests pnpm test -# Build +# Build all packages pnpm build + +# Start development server (docs + storybook) +pnpm dev:docs ``` +See [CONTRIBUTING.md](./CONTRIBUTING.md) for detailed contribution guidelines. + ## License Styleframe is [MIT licensed](https://github.com/styleframe-dev/styleframe/blob/main/LICENSE).