From e267d977d1fc612bb9fee817cd24c5ab89237cd9 Mon Sep 17 00:00:00 2001 From: Mumtahin Farabi Date: Mon, 24 Jun 2024 22:35:34 -0400 Subject: [PATCH] docs: Improve README.md package installing and running dev server instructions --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a56a625..d55c89a 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,3 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). - ## Getting Started Clone the repository: @@ -15,25 +13,29 @@ Install packages: ```bash npm i +# or +pnpm i +# or +yarn i ``` -First, run the development server: +Then, run the development server: ```bash -npm run dev +npm run dev:next # or -yarn dev +yarn dev:next # or -pnpm dev +pnpm dev:next # or -bun dev +bun dev:next ``` Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. ## Deploy on Vercel -This project is made using Next.js, and can easily be deployed on the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.j. +This project is made using [Next.js](https://nextjs.org/), and can easily be deployed on the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. Check out the [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.