Skip to content

Commit 9971ee2

Browse files
authored
Merge pull request #235 from mallurivikas/feat/enhanced-readme
Feat/enhanced readme
2 parents d26f54a + 3f1f299 commit 9971ee2

1 file changed

Lines changed: 137 additions & 41 deletions

File tree

README.md

Lines changed: 137 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,124 @@
1-
# LisBook - A Simple Audio Book Player
1+
# 🎧 LisBook - A Simple Audio Book Player
22

33
<div align="center">
44

55
![Purple Abstract A Letter Free Logo](https://github.com/user-attachments/assets/3d283391-9e0c-4e34-b302-eb96ea4d159c)
66

7+
[![GitHub stars](https://img.shields.io/github/stars/Ctoic/Lisbook?style=for-the-badge&color=yellow)](https://github.com/Ctoic/Lisbook/stargazers)
8+
[![GitHub forks](https://img.shields.io/github/forks/Ctoic/Lisbook?style=for-the-badge&color=blue)](https://github.com/Ctoic/Lisbook/network)
9+
[![GitHub issues](https://img.shields.io/github/issues/Ctoic/Lisbook?style=for-the-badge&color=red)](https://github.com/Ctoic/Lisbook/issues)
10+
[![GitHub license](https://img.shields.io/github/license/Ctoic/Lisbook?style=for-the-badge&color=green)](https://github.com/Ctoic/Lisbook/blob/main/LICENSE)
11+
12+
*Immerse yourself in the world of audiobooks with simplicity and elegance*
13+
714
</div>
815

9-
## Description
16+
---
17+
18+
## 📖 Description
19+
20+
LisBook is a **beautifully crafted audiobook player** designed for book lovers who value simplicity and functionality. Transform your reading experience by listening to your favorite books in MP3 format with our intuitive and feature-rich player.
21+
22+
> 🌟 **"Reading is dreaming with open eyes"** - LisBook makes that dream even more accessible!
23+
24+
### ✨ Key Features:
25+
26+
<table>
27+
<tr>
28+
<td width="50%">
29+
30+
🎮 **Playback Controls**
31+
- ▶️ **Play/Pause**: Seamless audio control
32+
- ⏹️ **Stop**: Reset and restart anytime
33+
- ⏭️ **Chapter Navigation**: Skip between chapters effortlessly
1034

11-
LisBook is a straightforward audiobook player designed for simplicity and ease of use. With LisBook, you can listen to your favorite books in MP3 format. The app provides essential playback features such as play, pause, stop, and the ability to skip chapters. You can also adjust playback speed and volume to suit your listening preferences.
35+
</td>
36+
<td width="50%">
1237

13-
### Key Features:
38+
⚙️ **Customization**
39+
- 🚀 **Speed Control**: Listen at your perfect pace
40+
- 🔊 **Volume Adjustment**: Perfect audio levels
41+
- 🎨 **Theme Options**: Personalize your experience
42+
43+
</td>
44+
</tr>
45+
</table>
1446

15-
- **Play/Pause**: Start or pause your audiobook anytime.
16-
- **Stop**: Stop the audio playback and reset the position.
17-
- **Skip Chapters**: Easily navigate between chapters.
18-
- **Change Speed**: Listen at your desired speed.
19-
- **Change Volume**: Adjust the volume as needed.
20-
- **Change Theme**: Personalize the appearance with different themes.
47+
LisBook is all about **simplicity and convenience**, making your audiobook journey smooth, customizable, and absolutely delightful! 🌈
2148

22-
LisBook is all about simplicity and convenience, making your audiobook experience smooth and customizable.
49+
---
2350

24-
## Screenshots
51+
## 📱 Screenshots
52+
53+
<div align="center">
2554

2655
![LisBook Screenshot](/Images/Lisbook-App-ScreeShot.jpg)
2756

28-
## How to Contribute to LisBook During Hacktoberfest 🎉🎃🎃
57+
*Experience the clean and intuitive interface of LisBook*
58+
59+
</div>
60+
61+
---
62+
63+
## 🎃 Hacktoberfest Contribution Guide
64+
65+
<div align="center">
66+
67+
### 🎉 **Join the LisBook Community!** 🎉
68+
*We're excited to be part of Hacktoberfest and would love your contributions!*
69+
70+
</div>
71+
72+
### 🚀 Ways to Contribute:
2973

30-
We’re thrilled to be part of Hacktoberfest! You can join us in improving and growing LisBook by contributing during this event.
74+
| 🐛 **Bug Fixes** | 🎨 **UI Improvements** |**New Features** | 📱 **Mobile Responsive** | 📚 **Documentation** |
75+
|---|---|---|---|---|
76+
| Spot and squash bugs | Enhance design & UX | Implement cool features | Improve device compatibility | Clarify and improve docs |
3177

32-
### Ways to Contribute:
78+
### 🔧 Quick Start Guide:
3379

34-
- **Fixing Bugs**: Spot any bugs? Help us squash them!
35-
- **Improving UI**: Have design ideas? Enhance the look and feel of LisBook.
36-
- **Adding New Features**: Got ideas for new features? Feel free to implement them.
37-
- **Mobile Responsiveness**: Help make LisBook more responsive on different devices.
38-
- **Improving Documentation**: Good with words? Help us improve the clarity and quality of our documentation.
80+
```bash
81+
# 1. Fork this repository (click the Fork button above! ⭐)
3982

40-
### Steps to Contribute:
83+
# 2. Clone your fork
84+
git clone https://github.com/YOUR_USERNAME/Lisbook.git
85+
cd Lisbook
4186

42-
1. **Fork this Repository**: Click the "Fork" button at the top of this repository.
43-
2. **Clone Your Fork**: Use `git clone` to clone your fork to your local machine.
87+
# 3. Create a new branch
88+
git checkout -b feature/your-amazing-feature
4489

45-
3. **Create a New Branch**: Create a branch for your changes.
46-
4. **Make Your Changes**: Implement your changes and improvements.
47-
5. **Commit and Push**: Commit your changes and push them to your forked repository.
48-
6. **Open a Pull Request**: Go to the original repository, click on the "Pull Requests" tab, and open a new pull request.
90+
# 4. Make your changes
91+
# ... code, code, code ... 💻
4992

50-
We will review your pull request and merge it if it aligns with the project goals.
93+
# 5. Commit and push
94+
git add .
95+
git commit -m "✨ Add amazing feature"
96+
git push origin feature/your-amazing-feature
5197

52-
### Hacktoberfest Tips:
98+
# 6. Open a Pull Request
99+
# Go to the original repo and click "New Pull Request" 🚀
100+
```
53101

54-
- Make sure your pull request follows the [Hacktoberfest Guidelines](https://hacktoberfest.com/participation).
55-
- Be respectful and patient while waiting for your PR to be reviewed.
102+
### 🎯 Hacktoberfest Tips:
56103

57-
We’re excited to see your contributions and hope you enjoy being part of LisBook’s journey!
104+
- ✅ Follow the [Hacktoberfest Guidelines](https://hacktoberfest.com/participation)
105+
- 🤝 Be respectful and patient during reviews
106+
- 💡 Check existing issues for contribution ideas
107+
- 🎨 Feel free to suggest improvements!
58108

59-
## License
109+
---
60110

61-
MIT License
111+
## 🌟 Our Amazing Contributors
62112

63-
## Author Info
113+
<div align="center">
64114

65-
- Twitter - [@Ct0ic](https://twitter.com/Ct0ic)
66-
- GitHub - [ctoic](https://github.com/ctoic)
67-
- LinkedIn - [Ct0ic](https://www.linkedin.com/in/ct0ic/)
115+
### 💜 **Thank you to these wonderful people who made LisBook possible!** 💜
68116

69-
## Contributors
117+
*Each contributor brings their unique skills and passion to make LisBook better for everyone* 🚀
70118

71-
<!-- readme: contributors -start -->
119+
</div>
120+
121+
<div align="center">
72122
<table>
73123
<tbody>
74124
<tr>
@@ -323,4 +373,50 @@ MIT License
323373
</tr>
324374
<tbody>
325375
</table>
326-
<!-- readme: contributors -end -->
376+
</div>
377+
378+
<div align="center">
379+
380+
### 🏅 **Hall of Fame** 🏅
381+
382+
[![Contributors](https://contrib.rocks/image?repo=Ctoic/Lisbook)](https://github.com/Ctoic/Lisbook/graphs/contributors)
383+
384+
*Each contributor has made LisBook more amazing! Thank you for being part of our journey.* 💜
385+
386+
**Want to join this amazing community?** [Start contributing today!](#-hacktoberfest-contribution-guide) 🚀
387+
388+
</div>
389+
390+
---
391+
392+
## 📄 License
393+
394+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
395+
396+
---
397+
398+
## 👨‍💻 Author Info
399+
400+
<div align="center">
401+
402+
**Created with ❤️ by Najam Ali Abbas**
403+
404+
[![Twitter](https://img.shields.io/badge/Twitter-%40Ct0ic-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white)](https://twitter.com/Ct0ic)
405+
[![GitHub](https://img.shields.io/badge/GitHub-ctoic-181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/ctoic)
406+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-Ct0ic-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/ct0ic/)
407+
408+
*Let's connect and build amazing things together!* 🤝
409+
410+
</div>
411+
412+
---
413+
414+
<div align="center">
415+
416+
### 🎯 **Ready to start your audiobook journey?**
417+
418+
**[⭐ Star this repository](https://github.com/Ctoic/Lisbook)****[🍴 Fork and contribute](https://github.com/Ctoic/Lisbook/fork)****[📖 Try LisBook now!](#-lisbook---a-simple-audio-book-player)**
419+
420+
*Made with 💜 for the love of books and technology*
421+
422+
</div>

0 commit comments

Comments
 (0)