From 42d41bb5c44b37592caaaef202eda4fa2907047e Mon Sep 17 00:00:00 2001 From: night0721 <77528305+night0721@users.noreply.github.com.> Date: Wed, 1 Nov 2023 23:55:50 +0000 Subject: [PATCH] readme --- README.md | 41 +++++++++++++++-------------------------- 1 file changed, 15 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 965a122..243dbb8 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,27 @@ -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). +# YouTube Dwonloader + +YouTube Downloader is a website written using TailwindCSS with Next.js ## Getting Started -First, run the development server: +To get started with the project, simply clone the repository and install the dependencies -```bash +```cmd +git clone https://github.com/night0721/youtube-downloader.git +cd youtube-downloader +npm i npm run dev -# or -yarn dev -# or -pnpm dev ``` -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## Support -You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file. +If you need support, you can join the [Discord server](https://discord.gg/SbQHChmGcp) -[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`. +## License -The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages. +This project is licensed under the GNU Public License v3.0. See [LICENSE](https://github.com/night0721/NullValkyrie/blob/master/LICENSE) for more information. -This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## Contribution -## Learn More - -To learn more about Next.js, take a look at the following resources: - -- [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. - -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! - -## Deploy on Vercel - -The easiest way to deploy your Next.js app is to use 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 our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +If you have any ideas for improvements or new features, please feel free to fork the project and create a pull request or open an issue. +All contributions are welcome, including translations, documentation, and code.