Skip to content

Commit bce32d9

Browse files
authored
Merge pull request #30 from Psamm-y/edit-readme
Add contribution guide to ReadeMe
2 parents 97113ed + e11c9c5 commit bce32d9

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

‎README.md‎

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
🚀 **TechPulse** is a tech news application built using the **MERN stack**. It leverages the **Algolia News API** to fetch the latest tech news, providing a seamless user experience with efficient state management and pagination.
44

5-
## Features
5+
## 🧩Features
66

77
- 🔹 **Efficient State Management** – Uses `useReducer` and `useContext` for smooth and optimized state handling.
88
- 🔹 **Custom Hooks** – Implements reusable custom hooks to modularize the logic.
99
- 🔹 **Pagination** – Enables seamless navigation through multiple pages of news articles.
1010
- 🔹 **Responsive UI** – Ensures a smooth user experience across all devices.
1111

12-
## Technologies Used
12+
## 💻Technologies Used
1313

1414
- **React.js** – Frontend development
1515
- **Algolia News API** – Fetches real-time tech news
1616
- **Vercel** – Deployment platform
1717

18-
## Installation and Setup
18+
## 📦Installation and Setup
1919

2020
1. Clone the repository:
2121
```bash
@@ -34,22 +34,34 @@
3434
npm start
3535
```
3636

37-
## Live Demo
37+
## 📺Live Demo
3838

3939
Check out the deployed version: [TechPulse on Vercel](https://techpulse-devleo.vercel.app/)
4040

4141
🔹 🔥 Trending News Section – Highlight the most popular articles.
4242
🔹 🌙 Dark Mode & Theming – Implement a customizable dark mode.
4343

44-
## Contributing
44+
## 🫱🏼‍🫲🏼Contributing
4545

46-
Contributions are welcome! Feel free to fork the repository and submit pull requests.
46+
Contributions are welcome! Feel free to fork the repository and submit pull requests. Here's a step-by-step guide to contribute:
4747

48-
## License
48+
Step 1: Fork the Repository
49+
Fork the TechPulse repository by clicking the "Fork" button on the top-right corner of the repository page.
50+
51+
Step 2: Clone the Forked Repository
52+
Clone the forked repository to your local machine using:
53+
54+
bash
55+
git clone https://github.com/your-username/TechPulse.git
56+
57+
Replace your-username with your actual GitHub username.
58+
59+
Step 3: Create a New Bran
60+
61+
## 📜License
4962

5063
This project is licensed under the **MIT License**.
5164

5265
---
5366

5467
**Developed by [Mehbub](https://github.com/devleo10)**
55-

0 commit comments

Comments
 (0)