Skip to content

Commit

Permalink
Add a README.md FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
ScienceOwl13 committed Aug 23, 2023
1 parent 8a857e7 commit ef52c33
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

<img width="300px" align="right" src="./screenshots/tray.png"/>This tool makes it possible to keep a chronically plugged in Apple Silicon Macbook at `80%` battery, since that will prolong the longevity of the battery. It is free and open-source and will remain that way.


> Want to know if this tool does anything or is just a placebo? Read [this excellent article](https://batteryuniversity.com/article/bu-808-how-to-prolong-lithium-based-batteries). TL;DR: keep your battery cool, keep it at 80% when plugged in, and discharge it as shallowly as feasible.
### Requirements
Expand All @@ -12,7 +11,7 @@ This is an app for Apple Silicon Macs. It will not work on Intel macs. Do you ha
### Installation

- Option 1: install through brew with `brew install battery`
- Option 2: [You can download the latest app dmg version here]( https://github.com/actuallymentor/battery/releases/ ).
- Option 2: [You can download the latest app dmg version here](https://github.com/actuallymentor/battery/releases/).
- Option 3: command-line only installation (see section below)

The first time you open the app, it will ask for your administator password so it can install the needed components. Please note that the app:
Expand All @@ -28,7 +27,6 @@ Do you have questions, comments, or feature requests? [Open an issue here](https

---


## 🖥 Command-line version

> If you don't know what a "command line" is, ignore this section. You don't need it.
Expand All @@ -47,7 +45,7 @@ curl -s https://raw.githubusercontent.com/actuallymentor/battery/main/setup.sh |

This will:

1. Download the precompiled `smc` tool in this repo (built from the [hholtmann/smcFanControl]( https://github.com/hholtmann/smcFanControl.git ) repository)
1. Download the precompiled `smc` tool in this repo (built from the [hholtmann/smcFanControl](https://github.com/hholtmann/smcFanControl.git) repository)
2. Install `smc` to `/usr/local/bin`
3. Install `battery` to `/usr/local/bin`

Expand All @@ -68,7 +66,6 @@ After running `battery charging on` you will see it change to this:

![Battery charging](./screenshots/charging-screenshot.png)


For help, run `battery` without parameters:

```
Expand Down Expand Up @@ -145,10 +142,18 @@ This tool calls a number of urls, blocking all of them will only break auto-upda

All urls are called over `https` and so not leak data. Unidentified Analytics keeps track of unique ip addresses that open the app, but nothing else.

### What distinguishes this project from Optimized Charging?

Optimized Charging, a feature that is built into MacOS, aims to ensure the longevity and health of your battery. It does so by "delaying charging the battery past 80% when it predicts that you’ll be plugged in for an extended period of time, and aims to charge the battery before you unplug," as explained in Apple's user guide.

Additionally, Optimized Charging uses machine learning to decide when the battery should be held at 80%, and when it should become fully charged. If your Mac is not plugged in on a regular schedule, optimized charging will not work as intended.

This app is a similar alternative to Optimized Charging, giving the user control over when it is activated, what percentage the battery should be held at, and more.

### How do I support this project?

Do you know how to code? Open a pull-request for a feature with the label [help wanted (PR welcome)](https://github.com/actuallymentor/battery/labels/help%20wanted%20%28PR%20welcome%29).

Do you have an awesome feature idea? [Add a feature request](https://github.com/actuallymentor/battery/issues/new/choose)

Do you just want to keep me motivated to update the app? [Tweet at me](https://twitter.com/actuallymentor)
Do you just want to keep me motivated to update the app? [Tweet at me](https://twitter.com/actuallymentor)

0 comments on commit ef52c33

Please sign in to comment.