From 2e607b48c080649852337e66fe60f791d4a5762b Mon Sep 17 00:00:00 2001 From: Priyanshu Trivedi Date: Thu, 19 Oct 2023 14:36:23 +0530 Subject: [PATCH] added README.md --- README.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 59 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..67a96ef --- /dev/null +++ b/README.md @@ -0,0 +1,59 @@ +# NewsSync (News Website) + + + +[NewsSync ](https://priyanshutrivedi07.github.io/NewsSync/) is a web application that delivers real-time news headlines fetched from various sources using a news API. Built with HTML, CSS, and JavaScript, this app provides a seamless and engaging experience for staying updated with the latest news. + +## Some Key Features + +- **Real-Time Updates :** Get the latest news headlines as they happen. +- **User-Friendly UI :** Intuitive and responsive design for easy navigation. +- **Engaging Thumbnails :** Visualize news stories with eye-catching thumbnails. +- **Detailed Info :** Each article includes title, source, description and publication date. +- **Search Functionality :** Search for specific news topics of your interest. +- **Read More :** Dive into full articles with the "Read More" button. + +## Demo 👁‍🗨 + + Explore the live demo: [NewsSync ↗ ](https://priyanshutrivedi07.github.io/NewsSync/) + +## Tech Stack Used + +- HTML +- CSS +- JavaScript +- [News API](https://gnews.io/) for fetching news data + +## Getting Started + +1. Clone the repository : `git clone https://github.com/your-username/newswebapp.git` +2. Navigate to the project directory : `cd newswebapp` +3. Open `index.html` in your preferred web browser. + +## Usage + +- Upon opening the web app, you'll instantly see the latest news headlines. +- Use the search functionality to find news articles on specific topics. +- Click on the "Read More" button to access complete articles. + +## API Key + +To run the application, you'll need an API key from [News API](https://gnews.io/) . Insert your API key in `main.js`: + +```javascript +const API_KEY = 'YOUR_API_KEY'; +``` + + + + +## Contact +Connect with me on LinkedIn : [Priyanshu Trivedi ↗](https://www.linkedin.com/in/priyanshu-trivedi/) \ No newline at end of file