Merge pull request #1311 from SmolekVT/patch-1

Create SECURITY.md

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,11 +1,22 @@
 ---
-name: Bug report
+name: Bug Report
 about: Create a report to help us improve
 title: ''
 labels: ''
 assignees: ''
 
 ---
+**MacBook (please complete the following information):**
+ - MacBook Model (https://support.apple.com/en-us/HT201608):
+ - macOS Version (https://support.apple.com/en-us/HT201260):
+ - Charger Model (Apple, Third Party, Wattage,...):
+ - Charging Cable (MagSafe 2, MagSafe 3, USB-C, Apple, Third Party,...):
+ - AlDente Pro or AlDente Free:
+ - AlDente Version:
+ - List or add screenshots of all enabled/disabled settings in AlDente:
+ - Please share a debug file the next time this happens so that we can assess this issue better. You can find a guide on How to generate and share a debug file on our blog(https://apphousekitchen.com/how-to-generate-and-share-a-debug-file/).
+ - External Monitor connected?
+ - MacBook used in Clamshell Mode (with the lid closed)?
 
 **Describe the bug**
 A clear and concise description of what the bug is.
@@ -17,18 +28,11 @@ Steps to reproduce the behavior:
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
+**Expected Behavior**
 A clear and concise description of what you expected to happen.
 
-**Screenshots**
-If applicable, add screenshots or screen recordings to help explain your problem.
-
-**MacBook (please complete the following information):**
- - MacBook model (https://support.apple.com/en-us/HT201608)
- - macOS version (https://support.apple.com/en-us/HT201260)
- - AlDente Pro or AlDente Free?
- - AlDente Version?
- - List of all enabled/disabled settings in AlDente:
+**Screenshots and Screen Recordings**
+If applicable, add screenshots or screen recordings of the issue to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.

AlDente/Helper.swift

@@ -248,7 +248,8 @@ final class Helper {
             print("helperVersion:", helperVersion, " version from helper:", version)
             if !helperVersion.elementsEqual(version) {
                 reply(false)
-                return()            }
+                return()
+            }
             else{
                 self.isInitialized = true
                 reply(true)

README.md

@@ -5,84 +5,36 @@ _MacOS menu bar tool to limit maximum charging percentage_
 
 ## Why do I need this?
 Li-Ion batteries (like the one in your MacBook) last the longest when operating between 20 and 80 percent. Keeping your battery at 100% at all times can shorten the lifespan of your MacBook significantly.
-More information can be found here:
-<https://batteryuniversity.com/article/bu-415-how-to-charge-and-when-to-charge>
+More information can be found at [Battery University](https://batteryuniversity.com/article/bu-415-how-to-charge-and-when-to-charge).
 
 ## What’s AlDente Pro?
-AlDente Pro is our paid version of AlDente. It has many more features such as Heat Protection, Sailing Mode, Top Up, Calibration Mode,... It offers a better design and has live status icons. If you are interested in getting the most out of your battery, check out our website: https://apphousekitchen.com/
+AlDente Pro is our paid version of AlDente. It has many more features such as Heat Protection, Sailing Mode, Top Up, Calibration Mode,... It offers a better design and has live status icons. If you are interested in getting the most out of your battery, check out our [website](https://apphousekitchen.com/).
 
-AlDente Pro is now available in Setapp too: https://apphousekitchen.com/pricing/
+AlDente Pro is now available on [Setapp](https://apphousekitchen.com/pricing/) too.
 
 ## Features of AlDente Free
-* Charge Limiter allows you to set your maximum charging percentage between 20 and 100 percent. You can either set it by using the slide bar or by typing in the desired percentage in the field above and pressing enter afterwards. Read more about the Charge Limiter feature here: https://apphousekitchen.com/feature-explanation-charge-limiter/
-* Discharge - This feature allows your MacBook to run completely on Battery even if it is plugged in. Therefore, you can actively discharge your MacBook to a more healthy percentage. Unfortunately, while Discharge is activated, clamshell mode is not supported due to technical limitations. Read more about the Discharge feature here: https://apphousekitchen.com/feature-explanation-discharge/
+* Charge Limiter allows you to set your maximum charging percentage between 20 and 100 percent. You can either set it by using the slide bar or by typing in the desired percentage in the field above and pressing enter afterwards. Read more about the Charge Limiter feature in this article ["Feature Explanation: Charge Limiter"](https://apphousekitchen.com/feature-explanation-charge-limiter/).
+* Discharge - This feature allows your MacBook to run completely on Battery even if it is plugged in. Therefore, you can actively discharge your MacBook to a more healthy percentage. Unfortunately, while Discharge is activated, clamshell mode is not supported due to technical limitations. Read more about the Discharge feature in this article ["Feature Explanation: Discharge"](https://apphousekitchen.com/feature-explanation-discharge/).
 
 ## Supported MacBook Models (macOS 11 Big Sur or later required)
 
-<details>
-  <summary>Click here for supported MacBook Models</summary>
-  
-#### MacBook Pro
-* MacBook Pro (13-inch, M2, 2022)
-* MacBook Pro (16-inch, M1 Pro/Max, 2021)
-* MacBook Pro (14-inch, M1 Pro/Max, 2021)
-* MacBook Pro (13-inch, M1, 2020)
-* MacBook Pro (13-inch, 2020, Two Thunderbolt 3 ports)
-* MacBook Pro (13-inch, 2020, Four Thunderbolt 3 ports)
-* MacBook Pro (16-inch, 2019)
-* MacBook Pro (13-inch, 2019, Two Thunderbolt 3 ports)
-* MacBook Pro (15-inch, 2019)
-* MacBook Pro (13-inch, 2019, Four Thunderbolt 3 ports)
-* MacBook Pro (15-inch, 2018)
-* MacBook Pro (13-inch, 2018, Four Thunderbolt 3 ports)
-* MacBook Pro (15-inch, 2017)
-* MacBook Pro (13-inch, 2017, Four Thunderbolt 3 ports)
-* MacBook Pro (13-inch, 2017, Two Thunderbolt 3 ports)
-* MacBook Pro (15-inch, 2016)
-* MacBook Pro (13-inch, 2016, Four Thunderbolt 3 ports)
-* MacBook Pro (13-inch, 2016, Two Thunderbolt 3 ports)
-* MacBook Pro (Retina, 15-inch, Mid 2015)
-* MacBook Pro (Retina, 13-inch, Early 2015)
-* MacBook Pro (Retina, 15-inch, Mid 2014)
-* MacBook Pro (Retina, 13-inch, Mid 2014)
-* MacBook Pro (Retina, 15-inch, Late 2013)
-* MacBook Pro (Retina, 13-inch, Late 2013)
-
-#### MacBook Air
-* MacBook Air (M2, 2022)
-* MacBook Air (M1, 2020)
-* MacBook Air (Retina, 13-inch, 2020)
-* MacBook Air (Retina, 13-inch, 2019)
-* MacBook Air (Retina, 13-inch, 2018)
-* MacBook Air (13-inch, 2017)
-* MacBook Air (13-inch, Early 2015)
-* MacBook Air (11-inch, Early 2015)
-* MacBook Air (13-inch, Early 2014)
-* MacBook Air (11-inch, Early 2014)
-* MacBook Air (13-inch, Mid 2013)
-* MacBook Air (11-inch, Mid 2013)
-
-#### MacBook 12"
-* MacBook (Retina, 12-inch, 2017)
-* MacBook (Retina, 12-inch, Early 2016)
-* MacBook (Retina, 12-inch, Early 2015)
-
-</details>
-
+Check out if your MacBook is supported on our [FAQ page](https://apphousekitchen.com/faq/).
 
 ## Download
 You can download the app from GitHub: <https://github.com/davidwernhart/AlDente/releases>
 
 ## Installation Guide
-An installation guide can be found on our website: https://apphousekitchen.com/installation-guide/
+An installation guide can be found on our website:[Installation Guide](https://apphousekitchen.com/installation-guide/)
 
 ## How to use
 When the installation is finished, enter your desired max. charging percentage by clicking on the 🍝 icon on your menu bar. Usually, the operating system will take a minute or two registering the changes, so be patient. You can check if it's working by setting the max. percentage to e.g.: 80%. After a while, clicking on your battery icon will report "Battery is not charging" if you have more than ≈73% left, even though your charger is connected. Notice that in this state, your MacBook is still powered by the charger, but the battery is not charging anymore.
 
 IMPORTANT: Keeping your battery at a lower percentage, such as under 80%, over weeks without doing full cycles (100%-0%) can result in a disturbed battery calibration. When this happens, your Macbook might turn off with 40-50% left or your battery capacity will drop significantly. However, this is only due to a disturbed battery calibration and not because of a faulty or degraded battery. To avoid this issue, we recommend doing at least one full cycle (0%-100%) every two weeks. Even if your battery calibration gets disturbed, doing 4+ full cycles will recalibrate your battery and the capacity will go up again.
 
-## FAQ's
-Check out our FAQ's on our website here: https://apphousekitchen.com/faq/
+## Support
+* Most questions are already answered on our [FAQ page](https://apphousekitchen.com/faq/) or on our [blog](https://apphousekitchen.com/blog/). Check them out!
+* E-mail support is only available for AlDente Pro customers. Check out our [support page](https://apphousekitchen.com/support/) if you want to contact us.
+* Due to limited recourses, we are not able providing support to AlDente Free users or here in Github.
 
 ## Other tools used in this project:
 * <https://github.com/beltex/SMCKit>

SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.