Skip to content

Commit

Permalink
added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
PriyanshuTrivedi07 committed Oct 19, 2023
1 parent 12d7775 commit 2e607b4
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# NewsSync (News Website)

<!-- ![NewsWebApp Screenshot](assets/newssync_SS.png)
![NewsWebApp Screenshot](assets/newssync_SS2.png) -->

[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';
```


<!-- ## Contributing
Contributions are welcome! If you have enhancements, bug fixes, or new features, here's how you can contribute:
#### Fork the repository.
1. Create a new branch: `git checkout -b feature/your-feature-name`
2. Make your changes and commit: `git commit -m 'Add your changes'`
3. Push to the branch: `git push origin feature/your-feature-name`
4. Open a pull request describing your changes. -->

## Contact
Connect with me on LinkedIn : [Priyanshu Trivedi ↗](https://www.linkedin.com/in/priyanshu-trivedi/)

0 comments on commit 2e607b4

Please sign in to comment.