Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
neeramrutia committed Jul 14, 2024
1 parent ea83666 commit 3b168cf
Showing 1 changed file with 70 additions and 3 deletions.
73 changes: 70 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,72 @@
# Mantine Gatsby template
# πŸ“Ή YouTube Video/Short Downloader

Get started with the template by clicking `Use this template` button on the top of the page.
Welcome to the **YouTube Video/Short Downloader**! This project is built with Gatsby and allows you to download YouTube videos and shorts with ease. πŸš€
## 🌟 Features
- πŸ” Search for YouTube videos and shorts
- πŸ“₯ Download videos in various formats
- 🎨 User-friendly interface
- ⚑ Fast and responsive

[Documentation](https://mantine.dev/guides/gatsby/)
## πŸ› οΈ Installation
To get started, clone the repository and install the necessary dependencies:
```bash
git clone https://github.com/neeramrutia/gatsby-youtube-video-downloader.git
cd gatsby-youtube-video-downloader
npm install
```
## πŸš€ Usage
Run the development server:
```bash
gatsby develop
```
- Open your browser and navigate to `http://localhost:8000` to use the application.

## πŸ“ Contributing

Contributions are welcome! If you have any ideas or suggestions, feel free to open an issue or submit a pull request.

### How to Contribute 🌟

1. **Fork the repository**: Click the "Fork" button on the top right corner of this page to create a copy of the repository on your GitHub account.
2. **Clone the repository**: Clone the forked repository to your local machine.
```bash
git clone https://github.com/neeramrutia/gatsby-youtube-video-downloader.git
cd youtube-downloader
```
3. **Create a branch**: Create a new branch for your feature or bugfix.
```bash
git checkout -b feature-name
```
4. **Make your changes**: Implement your feature or bugfix.
5. **Commit your changes**: Commit your changes with a meaningful message.
```bash
git add .
git commit -m "Add feature-name"
```
6. **Push your changes**: Push your changes to the forked repository.
```bash
git push origin feature-name
```
7. **Open a pull request**: Navigate to the original repository and click on the "New Pull Request" button. Provide a clear description of your changes and submit the pull request.


## πŸ“„ License

This project is licensed under the MIT License.

## πŸ™ Acknowledgements

- [Gatsby](https://www.gatsbyjs.com/) - The blazing fast static site generator
- [YouTube API](https://developers.google.com/youtube/) - For providing the video data

## πŸ“¬ Contact

If you have any questions or feedback, feel free to reach out:

- **Email**: [email protected]

Thank you for using the YouTube Video/Short Downloader! πŸŽ‰

---

<p align="center">Made with ❀️ by Neer Amrutia</p>

0 comments on commit 3b168cf

Please sign in to comment.