Skip to content
This repository has been archived by the owner on Sep 19, 2024. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
thebarbican19 committed Aug 9, 2023
2 parents 1acd836 + e84ea95 commit 3581404
Showing 1 changed file with 34 additions and 16 deletions.
50 changes: 34 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,57 @@
# BatteryBoi - A Battery Indicator for Winners
### What?
**BatteryBoi** (better name pending a [Twitter Poll](https://twitter.com/mistermeenr)) is a **replacement Battery Indicator for the MacOS Menu Bar**. <br><br><br>

### Why?
The battery icon really needed an indicator for how much time is left in terms of minutes and hours. So as a fun evening project, I [@MisterMeenr](https://twitter.com/mistermeenr) made it. <br><br><br>
![BatteryBoi Promo image](https://pub-3d59231d7ecc43e7af32a82026f9e071.r2.dev/batteryboi-promo.jpeg)
### What
**BatteryBoi** (better name pending a [Twitter Poll](https://twitter.com/mistermeenr)) is a **replacement Battery Indicator for the MacOS Menu Bar**. <br><br>

### Removing the Default
You can remove the default MacOS battery icon by holding *Command * & dragging the battery icon off the Menu Bar, releasing it will remove it. <br><br><br>
### Why
The battery icon really needed an indicator for how much time is left in terms of minutes and hours. So as a fun evening project, I [@MisterMeenr](https://twitter.com/mistermeenr) made it. <br><br>

### How (to Install)

1. You can install the app by downloading the [latest released .DMG file](https://github.com/thebarbican19/BatteryBoi/releases/). This contains an executable version of the app - **you do not need to Xcode to run this.**
2. Open/mount the DMG file and drag BatteryBoi into the Applications Folder. And that's it!
3. You can hide the default battery icon by going to **System Preferences** > **Control Center** > **Battery** > **Show in Menu Bar**
<br><br>

#### Updates
BatteryBoi does not currently have support to perform automatic updates. Please 🚶🏻 follow or ⭐️ start this repo to follow for release updates.
<br><br>

### Roadmap
This is just a fun project however, with your support, I will be adding...

- [X] **🔋 Battery Replacement**
- [ ] **🚀 Login at Launch**
- [ ] **➡️ Dynamic Width***
- [ ] **⬇️ Sparkle Intergration**
- [ ] **🚨 Improved Alerts**
- [ ] **🏝️ A Dynamic Island-Style Modal with Sexy Indicator**
- [ ] **📈 More Stats**
- [ ] **⌨️ Custom Keyboard Shortcuts**

<br><br><br>
<br>Ideas are welcome.

<br><br>

### Q&A
**Q** Does this app steal my data? <br>
**A** No, there's no tracking. Look at the code if you don't belive me.
**Q.** Does this app steal my data? <br>
**A.** The app **only tracks installs** with [Enalog](https://github.com/thebarbican19/EnalogSwift). If you don't belive me, check the source code.
<br><br>
**Q** Did you make any other sweet sweet apps I can try? <br>
**A** Yeah, [SprintDock](https://sprintdock.app) is my masterpeice. Check it out!
**Q.** Did you make any other sweet sweet apps I can try? <br>
**A.** Yeah, [SprintDock](https://sprintdock.app) is my masterpeice. Check it out!
<br><br>
**Q** The estimated time does not show up? <br>
**A** Estimated time until battery deplition is calculated by the System. Sometimes this information just isn't available. When it isn't, it will fall back on the Battery Percentage.

**Q.** The estimated time does not show up. Why? <br>
**A.** Estimated time until battery depletion is calculated by the System. Sometimes this information just isn't available. When it isn't, it will fall back on the Battery Percentage.
<br><br>
**Q.** Can I revert back to the old MacOS Battery Indicator?<br>
**A.** Yes! Go to **System Preferences** > **Control Center** > **Battery** > **Show in Menu Bar** and toggle it on.

<br><br><br>

<br><br>

### This is so good - Take My Money.
**BatteryBoi is FREE for everybody!** But if you want to support future development and see some of the roadmap items implemented, then consider donating via this [🔐 Secure Stripe Link](https://buy.stripe.com/14k7wl8PN5Dw81214a).
<br><be>

Thank you for your consideration.
#### Thank you for your consideration.

0 comments on commit 3581404

Please sign in to comment.