Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Vishu-221b authored Sep 23, 2023
1 parent 5f2178b commit fd4f6c7
Showing 1 changed file with 33 additions and 69 deletions.
102 changes: 33 additions & 69 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,27 @@
# Notes App

## Modern YouTube Clone Application
## Description

**Description:**
The Notes App is a modern web application built with React JS, designed to help you easily manage and organize your notes. It provides a user-friendly interface for creating, editing and organizing your notes efficiently.

This project is a modern YouTube clone application built in React JS with Material UI 5. It replicates some of the core features of YouTube, allowing users to search for and watch videos.
## Demo

**Demo:**
You can try out a live demo of this project [here](https://notes-by-vishu.netlify.app/).

You can check out a live demo of this project [here](https://notes-by-vishu.netlify.app/)
<br>
![Notes App](https://raw.githubusercontent.com/Vishu-221b/Notes-App/main/public/Screenshot%20(342).png)
![Notes App](https://raw.githubusercontent.com/Vishu-221b/Notes-App/main/public/Screenshot%20(343).png)

## Table of Contents

<div style="display: flex; justify-content: space-between; align-items: center;">
<a href="https://youtube-by-vishu.netlify.app/" target="_blank">
<img src="https://raw.githubusercontent.com/Vishu-221b/Youtube-Clone/main/public/Screenshot%20(342).png" style="width: 40%; max-height: 225px; alt="YouTube Clone">
</a>
<a href="https://youtube-by-vishu.netlify.app/" target="_blank">
<img src="https://raw.githubusercontent.com/Vishu-221b/Youtube-Clone/main/public/Screenshot%20(343).png" style="width: 40%; max-height: 225px;" alt="YouTube Clone">
</a>
</div>
<div style="margin: 20px 0; display: flex; justify-content: space-between; align-items: center;">
<a href="https://youtube-by-vishu.netlify.app/" target="_blank">
<img src="https://raw.githubusercontent.com/Vishu-221b/Youtube-Clone/main/public/Screenshot%20(344).png" style="width: 40%; max-height: 225px;" alt="YouTube Clone">
</a>
<a href="https://youtube-by-vishu.netlify.app/" target="_blank">
<img src="https://raw.githubusercontent.com/Vishu-221b/Youtube-Clone/main/public/Screenshot%20(345).png" style="width: 40%; max-height: 225px;" alt="YouTube Clone">
</a>
</div>
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Credits](#credits)
- [Author](#author)
- [Acknowledgments](#acknowledgments)








**Table of Contents:**

* [Installation](#installation)
* [Usage](#usage)
* [API Key Setup](#api-key-setup)
* [Contributing](#contributing)
* [License](#license)
* [Credits](#credits)
* [Author](#author)
* [Acknowledgments](#acknowledgments)

**Installation:**
## Installation

To run this project locally, follow these steps:

Expand All @@ -55,45 +30,34 @@ To run this project locally, follow these steps:
3. Run `npm install` to install dependencies.
4. Run `npm start` to start the development server.

**Usage:**

* Use the search bar to find videos.
* Click on a video to watch it.
* Enjoy a simplified YouTube experience!

**API Key Setup:**
## Usage

This project does not require an API key for basic functionality. However, if you want to extend its features with external APIs, you can follow the respective API documentation to obtain and configure the necessary keys.
- Create new notes easily.
- Edit and update existing notes.
- Organize your notes efficiently.

**Contributing:**
## Contributing

We welcome contributions to make this project even better. Here's how you can contribute:
We welcome contributions to make the Notes App even better. Here's how you can contribute:

* Submit bug reports or feature requests by opening an issue.
* Fork the repository, make changes, and submit a pull request for review.
- Submit bug reports or feature requests by opening an issue.
- Fork the repository, make changes, and submit a pull request for review.

**License:**
## License

This project is licensed under the [MIT License](LICENSE.md) - see the [LICENSE.md](LICENSE.md) file for details.

**Credits:**

* We would like to thank the creators of React JS and Material UI for their valuable resources and documentation.

**Author:**

* [Your Name]
* GitHub: [Your GitHub Profile](https://github.com/your-github-profile)
* Email: [[email protected]]
## Credits

**Acknowledgments:**
We would like to thank the React JS community for their valuable resources and documentation.

* Special thanks to our contributors and everyone who supported this project.
## Author

**FAQ (Optional):**
- Your Name
- GitHub: [Your GitHub Profile](https://github.com/your-github-profile)
- Email: [[email protected]]

* [Include FAQ here if applicable]
## Acknowledgments

**Additional Documentation (Optional):**
Special thanks to our contributors and everyone who supported this project.

* [Link to additional documentation or external resources if available]

0 comments on commit fd4f6c7

Please sign in to comment.