diff --git a/README.md b/README.md new file mode 100644 index 0000000..343bd96 --- /dev/null +++ b/README.md @@ -0,0 +1,33 @@ +# Deezer Downloader + +Battery assistant for prolonging the lifespan of your battery. Runs in the background, has configurable limits and can be enabled to run on startup. + +## What does it do? + +Good question. It gives you notifications about when to plus and unplug your charger. **Why?** Batteries loose the most capacity if the voltage difference is high, or staying at 100%. Hence, if you you use your laptop most of the time plugged in, it will decrease the capacity of the battery quicker than normal. + +Reference to the science: + +- http://batteryuniversity.com/learn/article/how_to_prolong_lithium_based_batteries +- https://www.popsci.com/charge-batteries-right + + +## Quickstart 💥 + +[Download](https://github.com/CupCakeArmy/volta/releases). Run. + +## Build 🔨 + +There are prebuilt binaries for macOS, Windows and Linux [here](https://github.com/CupCakeArmy/volta/releases). However you can also complile them yourself. + +```bash +# Install dependencies +npm i + +# Build the app +npm run pack:all +``` + +### Screen + +![Screenshot](https://i.imgur.com/DX8mjRE.png) \ No newline at end of file