diff --git a/README.md b/README.md index 9e7f780..e53c933 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,35 @@ # documents -协会文档 +Documents for nbtca. + +## How to use + +### Install dependencies + +1. Install Node.js +2. Install pnpm + ```bash + npm install -g pnpm + ``` +3. Install dependencies + ```bash + pnpm install + ``` + +### Start development server + +```bash +pnpm docs:dev +``` + +### Build for production + +```bash +pnpm docs:build +``` + +### Lint code + +```bash +pnpm lint +```