diff --git a/README.md b/README.md index fee1d03..d0bfe3d 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,26 @@ -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). +# SoraWebui -## Getting Started +## Quick Started -First, run the development server: +1. Clone project ```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev +git clone git@github.com:SoraWebui/SoraWebui.git ``` -Open [http://localhost](http://localhost) with your browser to see the result. - -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +2. install dependencies -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. - -## Learn More +```bash +cd SoraWebui && yarn +``` -To learn more about Next.js, take a look at the following resources: +3. run dev -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +```bash +yarn dev +``` -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +4. Open [http://localhost](http://localhost) with your browser to see it. ## Deploy on Vercel