From 7b25d4ac0652aca870bf0288bce5ff0d19a567b1 Mon Sep 17 00:00:00 2001 From: Complexlity <105590967+Complexlity@users.noreply.github.com> Date: Sat, 11 Mar 2023 17:50:52 +0100 Subject: [PATCH] update readme; add npm and yarn instructions --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7b334733..c9f38ba7 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,37 @@ Click the button to clone this repository and deploy it on Vercel: ## Local Development -First, run `pnpm i` to install the dependencies. +### Clone the repository -Then, run `pnpm dev` to start the development server and visit localhost:3000. +```sh +https://github.com/shuding/nextra-docs-template.git +cd nextra-docs-template +``` + +### Install dependencies and run development server + +**npm** + +```sh +npm install +npm run dev +``` + +**yarn** + +```sh +yarn install +yarn dev +``` + +**pnpm** + +```sh +pnpm i +pnpm dev +``` + +This will start the development server and you can view the app in your browser at http://localhost:3000. ## License